com.apama.session
Event CtrlParams


Control Parameter event that is passed back to the Source/Adapter on connection.
Since:
CMF 2.0.0

Member Summary
 dictionary<string, string >list
 
Action Summary
 voidaddParam(string paramName, string paramValue)

This function adds a parameter name and its corresponding value (as a string) to the list of Control Parameters. If the parameter name already exists, it will be overwritten with this new value.
 stringgetParam(string paramName)

This function gets the value (as a string) of the specified parameter name that has been added to this list of Control Parameters.
 booleanhasParam(string paramName)

This function allows the user to check whether the specified parameter name has been added to this list of Control Parameters.
 voidremoveParam(string paramName)

This function removes the specified parameter name from the list of Control Parameters.
 
Member Detail

list

dictionary<string, string > list

Action Detail

addParam

void addParam(string paramName, string paramValue)
This function adds a parameter name and its corresponding value (as a string) to the list of Control Parameters. If the parameter name already exists, it will be overwritten with this new value.
Parameters:
paramName - The name of the parameter to add to the list of Control Parameters.
paramValue - The value (as a string) of the parameter to be added to the list.

getParam

string getParam(string paramName)
This function gets the value (as a string) of the specified parameter name that has been added to this list of Control Parameters.
Parameters:
paramName - The name of the parameter to get the value for from the list.
Returns:
The value (as a string) if it has been added, or an empty string if the parameter has not been added to the list.

hasParam

boolean hasParam(string paramName)
This function allows the user to check whether the specified parameter name has been added to this list of Control Parameters.
Parameters:
paramName - The name of the parameter to check has been added to the list.
Returns:
true if it has been added, false otherwise.

removeParam

void removeParam(string paramName)
This function removes the specified parameter name from the list of Control Parameters.
Parameters:
paramName - The name of the parameter to be removed from the list of Control Parameters.