com.apama.session
Event SessionConfigSchema


The Session Config Parameter Schema event is passed from the Source/Adapter on registration. This event describes the control parameters (CP) that can (or must) be set on SessionStart to the Source/Adapter.
Since:
CMF 2.0.1

Action Summary
 sequence<string >getParamAllowableValues(string paramName)

This function gets a sequence of allowable values for the specified parameter. This can be used by the Source/Adapter to inform the user of an enumerated parameter value.
 stringgetParamDefaultValue(string paramName)

This function gets the default value for the specified parameter (as a string).
 stringgetParamDescription(string paramName)

This function gets the description of the specified parameter.
 stringgetParamType(string paramName)

This function gets the type of parameter as a string (e.g. "string", "boolean", "integer", "float", etc).
 booleanhasParam(string paramName)

This function allows the user to check whether the Source/Adapter supports the specified parameter name.
 booleanisParamReferenceOnly(string paramName)

This function returns whether the parameter is for reference purposes only or whether the parameter is configurable by the client on Session Start.
 booleanisParamRequired(string paramName)

This function returns whether the parameter is required to be passed back to the Source/Adapter on SessionStart, or whether the parameter is optional.
 
Action Detail

getParamAllowableValues

sequence<string > getParamAllowableValues(string paramName)
This function gets a sequence of allowable values for the specified parameter. This can be used by the Source/Adapter to inform the user of an enumerated parameter value.
Parameters:
paramName - The name of the parameter to get the sequence of allowable values for.
Returns:
A sequence of allowable values (as strings) of the parameter specified, or an empty string if the parameter is not supported or is not restricted to a set of values.

getParamDefaultValue

string getParamDefaultValue(string paramName)
This function gets the default value for the specified parameter (as a string).
Parameters:
paramName - The name of the parameter to get the default value for.
Returns:
The default value of the parameter specified as a string, or an empty string if the parameter is not supported or no default value is provided by the Source/Adapter.

getParamDescription

string getParamDescription(string paramName)
This function gets the description of the specified parameter.
Parameters:
paramName - The name of the parameter to get the description for.
Returns:
The description of the parameter requested, or an empty string if the requested parameter is not supported.

getParamType

string getParamType(string paramName)
This function gets the type of parameter as a string (e.g. "string", "boolean", "integer", "float", etc).
Parameters:
paramName - The name of the parameter to get the type of.
Returns:
The type of the parameter specified as a string, or an empty string if the parameter is not supported.

hasParam

boolean hasParam(string paramName)
This function allows the user to check whether the Source/Adapter supports the specified parameter name.
Parameters:
paramName - The name of the parameter to check is supported.
Returns:
true if supported, false otherwise.

isParamReferenceOnly

boolean isParamReferenceOnly(string paramName)
This function returns whether the parameter is for reference purposes only or whether the parameter is configurable by the client on Session Start.
Parameters:
paramName - The name of the parameter to check if it is for reference purposes only.
Returns:
true if the parameter is for reference purposes only. false if it is configurable by the client on Session Start.

isParamRequired

boolean isParamRequired(string paramName)
This function returns whether the parameter is required to be passed back to the Source/Adapter on SessionStart, or whether the parameter is optional.
Parameters:
paramName - The name of the parameter to check if it is required.
Returns:
true if the parameter is required to be passed on SessionStart, false if it can be set optionally.