FRAMES NO FRAMES | |||||||
| |||||||
SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION | DETAIL: IMPORT | CONSTANT | MEMBER | ACTION |
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. |
string |
getParamDefaultValue(string paramName)
This function gets the default value for the specified parameter (as a string). |
string |
getParamDescription(string paramName)
This function gets the description of the specified parameter. |
string |
getParamType(string paramName)
This function gets the type of parameter as a string (e.g. "string", "boolean", "integer", "float", etc). |
boolean |
hasParam(string paramName)
This function allows the user to check whether the Source/Adapter supports the specified parameter name. |
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. |
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. |
Action detail |
---|
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.
string getParamDefaultValue(string paramName)This function gets the default value for the specified parameter (as a string).
string getParamDescription(string paramName)This function gets the description of the specified parameter.
string getParamType(string paramName)This function gets the type of parameter as a string (e.g. "string", "boolean", "integer", "float", etc).
boolean hasParam(string paramName)This function allows the user to check whether the Source/Adapter supports the specified parameter name.
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.
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.
FRAMES NO FRAMES | |||||||
| |||||||
SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION | DETAIL: IMPORT | CONSTANT | MEMBER | ACTION |