com.apama.utils
Event ParamsSchema


The Parameter Schema event describes the parameters that can (or must) be set.
Since:
CMF 5.1.0

Action Summary
 voidaddItem(string name, string type, string defaultValue, sequence<string > allowableValues, string description, boolean required, boolean referenceOnly)

This function adds a new configuration parameter to the list with the full set of information.
 voidaddItemMinimal(string name, string type, string defaultValue, string description)

This function adds a new configuration parameter to the list with the full set of information.
 voidclear()

This function clears any current Schema Items from this event.
 sequence<string >getParamAllowableValues(string paramName)

This function gets a sequence of allowable values for the specified parameter.
 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.
 dictionary<string, string >getParamsAndTypes()

This function returns a list of all the parameters and their types as dictionary.
 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 schema 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.
 booleanisParamRequired(string paramName)

This function returns whether the parameter is required, or whether the parameter is optional.
 
Action Detail

addItem

void addItem(string name, string type, string defaultValue, sequence<string > allowableValues, string description, boolean required, boolean referenceOnly)
This function adds a new configuration parameter to the list with the full set of information.
Parameters:
name - The name of the parameter
type - The type of the parameter (e.g. "string", "boolean", "integer", "float", "sequence<string>", etc)
defaultValue - The default value of this parameter (blank if not required)
allowableValues - A sequence containing the allowable values for this configuration parameter (empty if not required)
description - A short description of what the parameter is for
required - A boolean flag indicating if the configuration parameter must be provided or is optional
referenceOnly - A boolean flag indicating if the configuration parameter is purely informational (IE not settable)
See Also:
com.apama.utils.ParamsSchema#addItemMinimal() - This action allows the user to add a configuration item with a minimal set of values

addItemMinimal

void addItemMinimal(string name, string type, string defaultValue, string description)
This function adds a new configuration parameter to the list with the full set of information.
Parameters:
name - The name of the parameter
type - The type of the parameter (e.g. "string", "boolean", "integer", "float", "sequence<string>", etc)
defaultValue - The default value of this parameter (blank if not required)
description - A short description of what the parameter is for
See Also:
com.apama.utils.ParamsSchema#addItem() - This action allows the user to add a configuration item with more information (such as the allowable values, etc)

clear

void clear()
This function clears any current Schema Items from this event.

getParamAllowableValues

sequence<string > getParamAllowableValues(string paramName)
This function gets a sequence of allowable values for the specified parameter.
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.

getParamsAndTypes

dictionary<string, string > getParamsAndTypes()
This function returns a list of all the parameters and their types as dictionary.
Returns:
The list of all the parameters and their types in a dictionary

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 schema 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.
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, 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 false if it can be set optionally