Apama Capital Markets Foundation  10.3.1.0
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Extra Params Processing API

Functions

AP_MDM_API void AP_MDM_SetExtraParam (AP_MDM_Interface *md, const char *subKey, const char *paramName, const char *type, const char *value, const char *description)
 
AP_MDM_API void AP_MDM_SetExtraParams (AP_MDM_Interface *md, const std::string &subKey, const ExtraParamList &extraParamList)
 
AP_MDM_API void AP_MDM_SetExtraParamValue (AP_MDM_Interface *md, const char *subKey, const char *paramName, const char *value)
 
AP_MDM_API void AP_MDM_SetExtraParamsValue (AP_MDM_Interface *md, const std::string &subKey, const ExtraParamValueList &extraParamValueList)
 
AP_MDM_API void AP_MDM_RemoveExtraParam (AP_MDM_Interface *md, const char *subKey, const char *paramName, AP_bool permanent=false)
 
AP_MDM_API void AP_MDM_RemoveExtraParams (AP_MDM_Interface *md, const std::string &subKey, const StringList &paramNames, AP_bool permanent=false)
 

Detailed Description

Extra Params Processing API

Function Documentation

AP_MDM_API void AP_MDM_RemoveExtraParam ( AP_MDM_Interface md,
const char *  subKey,
const char *  paramName,
AP_bool  permanent = false 
)

Remove the Extra Param Value (and optionally schema) for a single parameter for the supplied subKey to send at the next commit.

Parameters
mdThe AP_MDM_Interface to use for this Extra Param Data.
subKeyThe subscription key this Extra Param Data is for.
paramNameThe parameter name/key as a const char* to remove.
permanentIf false (default) will only blank the value. If true, will remove the value and schema.
See also
AP_MDM_SubscriptionCommit
AP_MDM_API void AP_MDM_RemoveExtraParams ( AP_MDM_Interface md,
const std::string &  subKey,
const StringList paramNames,
AP_bool  permanent = false 
)

Remove the Extra Param Value (and optionally schema) for multiple parameters for the supplied subKey to send at the next commit.

Parameters
mdThe AP_MDM_Interface to use for this Extra Param Data.
subKeyThe subscription key this Extra Param Data is for.
paramNamesThe list of parameter name/key as a StringList to remove.
permanentIf false (default) will only blank the values. If true, will remove the values and schemas.
See also
AP_MDM_SubscriptionCommit
StringList
AP_MDM_API void AP_MDM_SetExtraParam ( AP_MDM_Interface md,
const char *  subKey,
const char *  paramName,
const char *  type,
const char *  value,
const char *  description 
)

Set the Extra Param Schema and Value for a single parameter for the supplied subKey to send at the next commit.

Parameters
mdThe AP_MDM_Interface to use for this Extra Param Data.
subKeyThe subscription key this Extra Param Data is for.
paramNameThe parameter name/key as a const char* for this Extra Param Data.
typeThe type of the parameter value (eg. "integer", "string", "dictionary<integer, boolean>", etc) as a const char* for this Extra Param Data.
valueThe value as a const char* for this Extra Param Data.
descriptionThe description as a const char* for this Extra Param Data.
See also
AP_MDM_SubscriptionCommit
AP_MDM_API void AP_MDM_SetExtraParams ( AP_MDM_Interface md,
const std::string &  subKey,
const ExtraParamList extraParamList 
)

Set the Extra Param Schema and Value for multiple parameters for the supplied subKey to send at the next commit.

Parameters
mdThe AP_MDM_Interface to use for this Extra Param Data.
subKeyThe subscription key this Extra Param Data is for.
extraParamListThe list of Extra Param Data (name, type, value, description).
See also
AP_MDM_SubscriptionCommit
ExtraParamList
ExtraParam
AP_MDM_API void AP_MDM_SetExtraParamsValue ( AP_MDM_Interface md,
const std::string &  subKey,
const ExtraParamValueList extraParamValueList 
)

Set the Extra Param Value for multiple parameters for the supplied subKey to send at the next commit.

Parameters
mdThe AP_MDM_Interface to use for this Extra Param Data.
subKeyThe subscription key this Extra Param Data is for.
extraParamValueListThe list of Extra Param Values Data (name, value).
See also
AP_MDM_SubscriptionCommit
ExtraParamValueList
ExtraParamValue
AP_MDM_API void AP_MDM_SetExtraParamValue ( AP_MDM_Interface md,
const char *  subKey,
const char *  paramName,
const char *  value 
)

Set the Extra Param Value for a single parameter for the supplied subKey to send at the next commit.

Parameters
mdThe AP_MDM_Interface to use for this Extra Param Data.
subKeyThe subscription key this Extra Param Data is for.
paramNameThe parameter name/key as a const char* for this Extra Param Data.
valueThe value as a const char* for this Extra Param Data.
See also
AP_MDM_SubscriptionCommit