This section contains a list of built-in functions in GateKeeper language.
![]() | Note |
|---|---|
lhs & rhs are used to denote the left-hand-side and right-hand-side operands. |
| Built-In Function | Usage | Allowed Types |
|---|---|---|
|
|
negate rhs - rhs |
integer, double, duration and money |
|
|
! rhs not rhs |
boolean |
|
|
lhs or rhs lhs || rhs |
Allowed types: boolean |
|
|
lhs and rhs lhs && rhs |
boolean |
|
|
lhs in (rhs1, rhs2, rhs3, ... The lhs == rhs1 or lhs == rhs or lhs == lhs == rhs |
lhs and rhs must be of the same type, except that integer and double types can be compared. |
|
|
lhs notIn ( rhs1, rhs2, rhs3 … ) The lhs and rhs values must be of the same type, except that integer and double types can be compared. The lhs != rhs1 and lhs != rhs2 and lhs!=rhs3 | |
|
|
lhs equals rhs lhs == rhs The lhs and rhs values must be the same type or except that integer and double types can be compared. |
All types |
|
|
lhs notEquals rhs lhs != rhs The lhs and rhs values must be the same type or except that integer and double types can be compared. |
All types |
|
|
lhs lessThan rhs lhs < rhs The lhs and rhs values must be the same type or except that integer and double types can be compared. | |
|
|
lhs greaterThan rhs lhs > rhs The lhs and rhs values must be the same type or except that integer and double types can be compared. |
integer, double, money, datetime, duration |
|
|
lhs lessThanOrEquals rhs lhs <= rhs The lhs and rhs values must be the same type or except that integer and double types can be compared. |
integer, double, money, datetime, duration |
|
|
lhs greaterThanOrEquals rhs lhs >= rhs The lhs and rhs values must be the same type, or except that integer and double types can be compared. |
integer, double, money, datetime, duration |
|
|
lhs plus rhs lhs + rhs Integer and double can be operated on, which will result in a double unless both operands are integers. Operations on money require that both lhs and rhs be the money type. A duration can be added to a duration, resulting in a duration. A datetime can be added to a duration or a duration can be added to a datetime, resulting in a datetime. |
integer, double, money, datetime, duration |
| lhs minus rhs lhs - rhs |
Integer and double can be operated on, which will result in a double unless both operands are integers. Operations on money require that both lhs and rhs be the money type. A duration can be subtracted from a duration, resulting in a duration. A duration can be subtracted from a datetime, a datetime must be the lhs and a duration must be the rhs, resulting in a datetime. |
|
lhs times rhs lhs * rhs |
Integer and double can be operated on, which will result in a double unless both operands are integers. For money, money can be multiplied by an integer or double, resulting in money. For duration, a duration can be multiplied by an integer, resulting in a duration. |
|
lhs div rhs lhs / rhs |
Integer and double can be operated on, which will result in a For money, money can be divided by an integer or double, the lhs must be a money value and the rhs must be an integer or double, resulting in money. |
| if(conditional-exp, true-exp, false-exp) conditional-exp ? true-exp : false-exp | conditional-exp must resolve to boolean true-exp and false-exp operands must be the same type |
| lhs condition rhs | Example: MyRole == 'Caller' orSay 'The role does not match';
|
| min(lhs, rhs) | All comparable types (all except boolean and string). All operands must be the same type |
| max(lhs, rhs) | All comparable types (all except boolean and string). All operands must be the same type |
| max(lhs, rhs) | All comparable types (all except boolean and string). All operands must be the same type |
| mod(lhs, rhs) | Integer Results in the integer remainder of dividing lhs by rhs. |
| cat(lhs, rhs) | String Results in the combined string of lhs and rhs. |
| getCurrencyCode(rhs) | Returns the currency code as a string. |