Context¶
Definition¶
Extends¶
Extended By¶
None
Description¶
Context for this callstack
Method Summary¶
| Owner | Name | Return Type | Description |
|---|---|---|---|
| Object | getClassName() | String | Returns the string name of this object's class type. |
| Context | getClassTypes() | Set | Returns the context of the calling parent. For example, the method,formula or callback that called this method |
| Context | getDefaultDatasource() | String | Returns the default datasource for this context |
| Context | getLimit() | Long | Returns the limit of this context |
| Context | getLocation() | String | Returns the location of this block of code in the format: SOURCE:LINENUM |
| Context | getParent() | Context | Returns the context of the calling parent which is the method,formula or callback that called the current block of code |
| Context | getRuntimeNanos() | Long | Returns the amount of time this context has lived in nanoseconds |
| Context | getStartTimeUTCN() | UTCN | Returns the start time of this context in nanos |
| Context | getTimeout() | Long | Returns the timeout in milliseconds of this context |
| Context | getTimeoutUTCN() | UTCN | Returns the wall-clock time at which this context will throw a timeout error |
| Context | getTimezone() | String | Returns the timezone associated with this context |
| Context | getUsername() | String | Returns the username associated with this context |
| Context | getVar(varname) | Set | Returns the value associated with a variable. If the variable does not exist null is returned. In the case of null, use getVarDeclaredType to determine if the value exists and is null or does not exist |
| Context | getVarDeclaredType(varname) | String | Returns variable type |
| Context | getVarIsConst(varname) | String | Returns true if supplied variable name is a const, or false if not. If the variable does not exist returns null |
| Context | getVars() | Set | Returns all variable names |
| Object | toJson() | String | Returns a string of a json representation of this object. |
Method Definitions¶
getClassName()¶
Description¶
Returns the string name of this object's class type.
getClassTypes()¶
Description¶
Returns the context of the calling parent. For example, the method,formula or callback that called this method
getDefaultDatasource()¶
String Context::getDefaultDatasource()
Description¶
Returns the default datasource for this context
getLimit()¶
Description¶
Returns the limit of this context
getLocation()¶
Description¶
Returns the location of this block of code in the format: SOURCE:LINENUM
getParent()¶
Description¶
Returns the context of the calling parent which is the method,formula or callback that called the current block of code
getRuntimeNanos()¶
Long Context::getRuntimeNanos()
Description¶
Returns the amount of time this context has lived in nanoseconds
getStartTimeUTCN()¶
UTCN Context::getStartTimeUTCN()
Description¶
Returns the start time of this context in nanos
getTimeout()¶
Description¶
Returns the timeout in milliseconds of this context
getTimeoutUTCN()¶
UTCN Context::getTimeoutUTCN()
Description¶
Returns the wall-clock time at which this context will throw a timeout error
getTimezone()¶
Description¶
Returns the timezone associated with this context
getUsername()¶
Description¶
Returns the username associated with this context
getVar(varname)¶
Set Context::getVar(String varname)
Description¶
Returns the value associated with a variable. If the variable does not exist null is returned. In the case of null, use getVarDeclaredType to determine if the value exists and is null or does not exist
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varname | String |
getVarDeclaredType(varname)¶
String Context::getVarDeclaredType(String varname)
Description¶
Returns variable type
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varname | String |
getVarIsConst(varname)¶
String Context::getVarIsConst(Boolean varname)
Description¶
Returns true if supplied variable name is a const, or false if not. If the variable does not exist returns null
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varname | Boolean |
getVars()¶
Description¶
Returns all variable names
toJson()¶
Description¶
Returns a string of a json representation of this object.