Callback¶
Definition¶
Extends¶
Extended By¶
None
Description¶
AMI Script Callback
Method Summary¶
| Owner | Name | Return Type | Description |
|---|---|---|---|
| Callback | getAmiScript() | String | Returns the amiscript defined for this callback as a string, null if not defined. |
| Object | getClassName() | String | Returns the string name of this object's class type. |
| Callback | getDRI() | String | DRI of this callback |
| Callback | getName() | String | name of this callback |
| Callback | getOwner() | DashboardResource | Returns the DashboardResource that this callback is owned by. |
| Callback | getParamTypes() | Map | Returns an ordered map of (key, type) pair for this callback. |
| Callback | getParams() | List | Returns an ordered list of param names for this callback. |
| Callback | getReturnType() | String | Returns the return type of this callback. |
| Callback | getTableset() | TableSet | Returns the Tableset object which contains column names and types of the underlying table. |
| Callback | invoke(map_of_params) | Object | Executes the callback, given a map of arguments. Map should contain (param_name, value) pairs. |
| Callback | invoke(list_of_params) | Object | Executes the callback given a list of arguments. The list should contain the values in the order of the params. |
| Callback | resetAmiScript() | Object | Resets the amiscript for this callback to the layout config default. |
| Callback | setAmiScript(amiscript) | Object | Sets the amiscript for this callback. |
| Object | toJson() | String | Returns a json representation of this object. |
Method Definitions¶
getAmiScript()¶
String Callback::getAmiScript()
Description¶
Returns the amiscript defined for this callback as a string, null if not defined.
getDRI()¶
Description¶
DRI of this callback
getName()¶
Description¶
name of this callback
getOwner()¶
DashboardResource Callback::getOwner()
Description¶
Returns the DashboardResource that this callback is owned by.
getParamTypes()¶
Description¶
Returns an ordered map of (key, type) pair for this callback.
getParams()¶
Description¶
Returns an ordered list of param names for this callback.
getReturnType()¶
String Callback::getReturnType()
Description¶
Returns the return type of this callback.
getTableset()¶
TableSet Callback::getTableset()
Description¶
Returns the Tableset object which contains column names and types of the underlying table.
invoke(map_of_params)¶
Object Callback::invoke(Map map_of_params)
Description¶
Executes the callback, given a map of arguments. Map should contain (param_name, value) pairs.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| map_of_params | Map | map of params, where the name should match the param name (see getParams method). Missing params are mapped to null, misspelled params are ignored. |
invoke(list_of_params)¶
Object Callback::invoke(List list_of_params)
Description¶
Executes the callback given a list of arguments. The list should contain the values in the order of the params.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| list_of_params | List | list of params, must be same size as the number of params |
resetAmiScript()¶
Object Callback::resetAmiScript()
Description¶
Resets the amiscript for this callback to the layout config default.
setAmiScript(amiscript)¶
Object Callback::setAmiScript(String amiscript)
Description¶
Sets the amiscript for this callback.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| amiscript | String | amiscript to set on this callback |