Formula Model and API
- Last UpdatedSep 21, 2017
- 1 minute read
These classes expose functionality to get and modify Formulas. This functionality will typically be used in conjunction with the Formula Parameter and Formula Parameter API.
Formula Model
|
Name |
Type |
Description |
|---|---|---|
|
Id |
Integer |
Gets the ID. |
|
Name |
String |
Gets or sets the Formula name. |
|
Description |
String |
Gets or sets the Formula description |
|
State |
ModelStates |
Gets the state. (See ModelStates) |
|
Version |
Integer |
Gets the version |
|
CheckedOut |
Boolean |
Gets a value that indicates the Formula is checked out. |
|
Upgradeable |
Boolean |
Gets a value that indicates the Formula can be upgraded. |
|
Size |
Double |
Gets or sets the size. |
|
UnitOfMeasure |
String |
Gets or sets the unit of measure. |
Formula API
|
Name |
Description |
|
GetOne(string) |
Returns the latest version of the Formula which matches the passed in name. Does not return obsolete Formula. |
|
GetAll() |
Returns the latest version of all Formulas. Does not return obsoleted formulas. |
|
Add(string) |
Creates and returns a Formula using the provided Formula template name. The name of the new Formula is auto generated. |
|
Change(Formula) |
The Formula passed in will be used to update the Formula on the server. |
|
CheckOut(string) |
Checks out and returns a Formula |
|
CheckIn(Formula) |
Checks in the Formula. |
|
UndoCheckOut(Formula) |
The checked-out Formula will be reverted to the previous checked-in version. |
|
Upgrade(Formula) |
Upgrades the Formula. |
|
SetState(Formula, ModelStates, string) |
Used to change the state of the Formula. |