ACTION OBJECT
- Pedro Jose Sanchez Luling
An ACTION is an object generated dynamically by action_list API functions (see ACTION WEB SERVICES). It contains the description of an action that can be executed by the active SESSION USER.
RECORD PROPERTIES:
PROPERTY | NAME | TYPE | DESCRIPTION |
|---|---|---|---|
#ACTION.REF | Ref | TEXT | Is the reference of the ACTION returned. Depending on the class property it can be used to
|
#ACTION.NAME | Name | TEXT | Name of the action translated to the active SESSION language (e.g. "Publish the program") |
#ACTION.DESCRIPTION | Description | TEXT | More detailed description of the action |
#ACTION.CLASS | Class | TEXT | Class of object returned. See ACTION CLASSES below. |
#ACTION.TYPE | Type | TEXT | Type of ACTION. Is a coded value that can be used to display the list of actions with different styles (icons, colors...) |
ACTION CLASSES
ACTIONs are organized internally as nodes of an ACTION tree. Depending on its position in the ACTION tree, there exist three classes of nodes (#ACTION.CLASS property)
ACTION: this is a final node. It is an action that can be executed by invoking action_exec ()
PATH: This is an intermediate node. Represents a branch in the ACTION tree (like a folder in a file system). In ACTIONs with Class=”PATH”, we can use the Ref property to navigate through the ACTION tree (see ACTION WEB SERVICES).
INPUT: This is also an intermediate node, but the API needs some information from the user to navigate through the ACTION tree. This is similar to a PATH, but it is not possible to navigate farther unless the user provides the requested information. To continue navigating we must call again the corresponding action_list function passing the value requested (see ACTION WEB SERVICES).
XML representation
ACTION WEB SERVICES return a list of ACTION objects, where each action has the following XML structure:
<action>
<ref>action reference</ref>
<name>Name of the action</name>
<description>Description of the action</description>
<class>ACTION|PATH|INPUT</class>
<type>Type of action</type>
</action> |