Formula Parameter Model and API
- Last UpdatedJul 12, 2017
- 1 minute read
These classes expose functionality to get/modify Formula parameters and will typically be used in conjunction with the Formula and Formula API.
Formula Parameter Model
|
Name |
Type |
Description |
|---|---|---|
|
Id |
Integer |
Gets the ID. |
|
Name |
String |
Gets the name. |
|
Description |
String |
Gets the description. |
|
DataType |
DataType |
Gets the data type. (See DataType Enum) |
|
CustomDataTypeName |
String |
Gets the name of the custom data type. Returns an empty string if the DataType is Boolean, Double, Integer, or String. |
|
Group |
String |
Gets the name of the group the parameter belongs to. |
|
Target |
Object |
Gets or Sets the value of the target. The data type of the target will match the DataType of the parameter. |
|
MinValue |
Object |
Gets or sets the minimum value. Null is returned for undefined or for types that don’t support MinValue. |
|
MaxValue |
Object |
Gets or sets the maximum value. Null is returned for undefined or for types that don’t support MinValue. |
|
UnitOfMeasure |
String |
Gets the unit of measure. |
|
UseDefault |
Boolean |
Gets or sets whether the Target, MinValue, MaxValue, and ExtValues come from the Formula Template. |
|
FrequentlyUsed |
Boolean |
Gets or sets whether Formula parameter is FrequentlyUsed. |
|
ExtValues |
Parameter |
Used to get and set extension values. (See Parameter Extensions) |
Formula Parameter API
|
Name |
Description |
|
GetOne(string, string) |
Returns a Formula parameter, using the passed in Formula and parameter name. |
|
GetAll(string) |
Returns all parameters for the given Formula. |
|
Change(FormulaParameter) |
The Formula parameter passed in will be used to update the server. |