com.apama.utils
Event ParamsSchemaItem


The parameter schema item describes a single instance of a configurable parameter.
Since:
CMF 5.1.0

Action summary
 voidinitialise(string type, string defaultValue, sequence<string> allowableValues, string description, boolean required, boolean referenceOnly)

This action constructs the PCP event using the full set of information.
 voidinitialiseMinimal(string type, string defaultValue, string description)

This action constructs the PCP event with a minimal set of information.
 
Action detail

initialise

            void initialise(string type, string defaultValue, sequence<string> allowableValues, string description, boolean required, boolean referenceOnly)
        
This action constructs the PCP event using the full set of information.
Parameters:
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
description - A short description of what the parameter is for
required
referenceOnly
See Also:
com.apama.utils.ParamsSchemaItem#initialiseMinimal() - This action allows the user to construct the event with a minimal amount of information

initialiseMinimal

            void initialiseMinimal(string type, string defaultValue, string description)
        
This action constructs the PCP event with a minimal set of information.
Parameters:
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.ParamsSchemaItem#initialise() - This action allows the user to construct the event with the full set of information (such as the allowable values, etc)