DataSourceParameter Class Methods
In this section, the DataSourceParameter class methods are presented in alphabetical order.
Syntax
addUserValue(DSPValue_ID, Value)
Description
Use this method to add a user value to this data source parameter.
Parameters
|
Field or Control |
Definition |
|---|---|
| DSPValue_ID |
Specifies the ID of the user value as a string. |
| Value |
Specifies the value of the user value as a string. |
Returns
A DataSourceParameterValue object if successful, false otherwise.
Syntax
clone()
Description
Use this method to make a copy of this DataSourceParameter object.
Parameters
None.
Returns
A DataSourceParameter object exactly matching the current object.
Syntax
equals(&Object)
Description
Use this method to evaluate the equivalency of an object with the current data source parameter. Equivalency is established based on the value of two properties: the object's ID and the ObjectType.
Parameters
|
Field or Control |
Definition |
|---|---|
| &Object |
Specifies the object to be compared to the current DataSourceParameter object. |
Returns
A Boolean value: True if the items are equivalent, False otherwise.
Syntax
resetUserValues()
Description
Use this method to reset the UserValues collection.
Parameters
None.
Returns
An empty UserValues collection if successful, null otherwise.
Syntax
setRangeFromFieldTranslates(FieldName)
Description
Use this method to auto-populate the range values based on the translate values for the specified field.
Parameters
|
Field or Control |
Definition |
|---|---|
| FieldName |
Specifies the name of the field as a string. |
Returns
None.
Syntax
validateValue(Value, CheckPrompt)
Description
Use this method to validate the value according to its field type, the edit type, and the usage type. Date or date time values are translated to the standard format as a string. Exceptions or errors are raised for invalid values.
Parameters
|
Field or Control |
Definition |
|---|---|
| Value |
Specifies the value to be validated as a string. |
| CheckPrompt |
Specifies a Boolean value indicating whether the value should be checked against the valid values list of this data source parameter. The type of check depends on the edit type of this data source parameter, the valid values list could be a user-specified values list, translate values of a field, or values in a prompt table. When CheckPrompt is True, check the value; when False, check the data type of the value only. |
Returns
A string with the validated value.