All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.eNetwork.beans.HOD.MacroActionPause

java.lang.Object
   |
   +----com.ibm.eNetwork.beans.HOD.MacroAction
           |
           +----com.ibm.eNetwork.beans.HOD.MacroActionPause

public class MacroActionPause
extends MacroAction
This class represents one pause action associated with a MacroScreen object. The pause action is used for inserting a pause during the execution of macro actions.


Constructor Index

 o MacroActionPause()
Constructs an empty instance of a macro pause.
 o MacroActionPause(long)
Constucts a functional instance of a macro pause with the given parameter.

Method Index

 o execute()
Executes the pause action.
 o format(int, boolean)
Formats the action object's contents into a readable string.
 o getTimeout()
Returns the duration of the pause action.
 o halt()
Halts the pause action.
 o setAttributes(Hashtable)
Sets all the basic attributes for the Macro action from the String contents in the given hash table.
 o setTimeout(long)
Sets the duration of the pause action.

Constructors

 o MacroActionPause
 public MacroActionPause()
Constructs an empty instance of a macro pause.

If you use this constructor you must call all the set methods of this class to properly set up the action.

 o MacroActionPause
 public MacroActionPause(long argDuration)
Constucts a functional instance of a macro pause with the given parameter.

Parameters:
argDuration - pause duration in milliseconds

Methods

 o execute
 public void execute()
Executes the pause action.

Overrides:
execute in class MacroAction
 o halt
 public void halt()
Halts the pause action.

Overrides:
halt in class MacroAction
 o setTimeout
 public void setTimeout(long argTimeout)
Sets the duration of the pause action. The default pause is 10000 milliseconds (10 seconds).

Parameters:
argTimeout - new pause duration in milliseconds
 o getTimeout
 public long getTimeout()
Returns the duration of the pause action.

Returns:
pause duration for the action
 o format
 public String format(int argType,
                      boolean formatAll)
Formats the action object's contents into a readable string. Intended for visual feedback, like with the MacroDebugActionEvent class.

Parameters:
argType - reserved, currently only XML strings are supported
formatAll - if true, optional parameters will be formated also
Returns:
formated string that reflects the contents of the action
Overrides:
format in class MacroAction
 o setAttributes
 public MacroParseEvent setAttributes(Hashtable t) throws MacroException
Sets all the basic attributes for the Macro action from the String contents in the given hash table.

Parameters:
ht - hash table that contains string values of each attribute. Numeric and boolean values are converted from strings.
Overrides:
setAttributes in class MacroAction

All Packages  Class Hierarchy  This Package  Previous  Next  Index