com.sonicsw.esb.service.common
Interface SFCParameters

public interface SFCParameters

Method Summary

boolean	contains(java.lang.String parameterName) Indicates whether the specified parameter exists in this parameter set.
void	disableSubstitution() Disables variable substitution for this set of parameters.
void	enableSubstitution() Enables variable substitution for this set of parameters.
boolean	getBooleanParameter(java.lang.String parameterName)
byte	getByteParameter(java.lang.String parameterName)
double	getDoubleParameter(java.lang.String parameterName)
float	getFloatParameter(java.lang.String parameterName)
XQParameterInfo	getInfo(java.lang.String parameterName) Provides access to the standard XQParameterInfo for the specified parameter.
int	getIntParameter(java.lang.String parameterName)
long	getLongParameter(java.lang.String parameterName)
java.lang.String	getParameter(java.lang.String parameterName)
java.lang.String	getParameter(java.lang.String parameterName, java.lang.String defaultValue)
java.lang.Object	getParameterObject(java.lang.String parameterName)
java.lang.Object	getParameterObject(java.lang.String parameterName, java.lang.Object defaultValue)
java.lang.String	getReference(java.lang.String parameterName) Provides the reference (if any) for the specified parameter.
short	getShortParameter(java.lang.String parameterName)
XQParameters	getXQParameters() Provides access to the standard XQParameters.
boolean	isSubstitutionEnabled() Indicates whether substitution is currently enabled for this set of parameters.
java.io.InputStream	readReference(java.lang.String parameterName) Provides an input stream to read the reference (if any) for the specified parameter.
void	setName(java.lang.String name) Provides a name for this parameters instance for logging purposes.
void	writeToLog() Writes this set of parameters to the log.

Method Detail

setName

void setName(java.lang.String name)

Provides a name for this parameters instance for logging purposes.

contains

boolean contains(java.lang.String parameterName)

Indicates whether the specified parameter exists in this parameter set.

getInfo

XQParameterInfo getInfo(java.lang.String parameterName)

Provides access to the standard XQParameterInfo for the specified parameter.

getParameter

java.lang.String getParameter(java.lang.String parameterName)
                              throws SFCServiceException

Throws:

SFCServiceException

getParameterObject

java.lang.Object getParameterObject(java.lang.String parameterName)
                                    throws SFCServiceException

Throws:

SFCServiceException

getParameter

java.lang.String getParameter(java.lang.String parameterName,
                              java.lang.String defaultValue)

getParameterObject

java.lang.Object getParameterObject(java.lang.String parameterName,
                                    java.lang.Object defaultValue)

getBooleanParameter

boolean getBooleanParameter(java.lang.String parameterName)
                            throws SFCServiceException

Throws:

SFCServiceException

getIntParameter

int getIntParameter(java.lang.String parameterName)
                    throws SFCServiceException

Throws:

SFCServiceException

getShortParameter

short getShortParameter(java.lang.String parameterName)
                        throws SFCServiceException

Throws:

SFCServiceException

getLongParameter

long getLongParameter(java.lang.String parameterName)
                      throws SFCServiceException

Throws:

SFCServiceException

getDoubleParameter

double getDoubleParameter(java.lang.String parameterName)
                          throws SFCServiceException

Throws:

SFCServiceException

getFloatParameter

float getFloatParameter(java.lang.String parameterName)
                        throws SFCServiceException

Throws:

SFCServiceException

getByteParameter

byte getByteParameter(java.lang.String parameterName)
                      throws SFCServiceException

Throws:

SFCServiceException

getReference

java.lang.String getReference(java.lang.String parameterName)

Provides the reference (if any) for the specified parameter.

readReference

java.io.InputStream readReference(java.lang.String parameterName)
                                  throws SFCServiceException

Provides an input stream to read the reference (if any) for the specified parameter.

Throws:

SFCServiceException

writeToLog

void writeToLog()

Writes this set of parameters to the log.

enableSubstitution

void enableSubstitution()

Enables variable substitution for this set of parameters. Substitution is enabled by default.

disableSubstitution

void disableSubstitution()

Disables variable substitution for this set of parameters.

isSubstitutionEnabled

boolean isSubstitutionEnabled()

Indicates whether substitution is currently enabled for this set of parameters. Substitution is enabled by default.

See Also:

enableSubstitution(), disableSubstitution()

getXQParameters

XQParameters getXQParameters()

Provides access to the standard XQParameters.