All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.eNetwork.beans.HOD.MacroAction
java.lang.Object
|
+----com.ibm.eNetwork.beans.HOD.MacroAction
- public abstract class MacroAction
- extends Object
- implements Serializable, MacroParsable, HODConstants
The MacroAction class is the parent class of all macro actions
allowable for the Macro bean. Macro action represents one unique
action that is interpretable by the Macro bean. These actions can be
prompts, data extraction from the screen, screen input, and the like.
Each of these types of actions has its own class that is derived from
MacroAction.
When an action object is instantiated, it may be added to an object of
the MacroActions class. The MacroActions object may then be used to
construct a MacroScreen object, which is the basic unit within a macro.
When the screen corresponding to the MacroScreen object appears from the
host, the actions in the MacroActions collection for the MacroScreen
will be executed by the Macro bean.
Refer to each action class for details on each action.
- See Also:
- Macro, MacroScreen, MacroActions, MacroActionExtract, MacroActionInput, MacroActionMessage, MacroActionPause, MacroActionPrompt, MacroActionCustom, MacroActionBoxSelect, MacroActionCommWait, MacroActionMouseClick, MacroActionTrace
-
clone()
- Classes derived from this action must override this method for the
action to be functional in the Macro bean.
-
execute()
- Classes derived from this action must override this method for the
action to be functional in the Macro bean.
-
format(int, boolean)
- Returns a formatted string representation of the action.
-
halt()
- Classes derived from this action must override this method to do
any cleanup handling if the Macro bean calls this method to stop an
action in the middle of its execution.
-
setECLSession(ECLSession)
- Sets the Host Access Class Library session object of the action.
-
setOwner(Macro)
- Sets the owner of the action.
-
setRuntimeListeners(Vector)
- Sets the runtime listeners of the action.
execute
public void execute()
- Classes derived from this action must override this method for the
action to be functional in the Macro bean. This method is called by
the Macro bean to execute an action.
halt
public void halt()
- Classes derived from this action must override this method to do
any cleanup handling if the Macro bean calls this method to stop an
action in the middle of its execution.
setOwner
public void setOwner(Macro mac)
- Sets the owner of the action.
- Parameters:
- mac - new Macro bean owner of the action
clone
public Object clone()
- Classes derived from this action must override this method for the
action to be functional in the Macro bean. This method is called by
the Macro bean to clone an action.
- Overrides:
- clone
setRuntimeListeners
public void setRuntimeListeners(Vector v)
- Sets the runtime listeners of the action.
- Parameters:
- v - new Vector of MacroRuntimeListeners
setECLSession
public void setECLSession(ECLSession sess)
- Sets the Host Access Class Library session object of the action.
- Parameters:
- sess - new HACL session object of the action
format
public String format(int type,
boolean displayAll)
- Returns a formatted string representation of the action.
- Parameters:
- type - reserved, currently only XML strings are supported
- displayAll - if true, all optional parameters are also formatted.
All Packages Class Hierarchy This Package Previous Next Index