All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.eNetwork.beans.HOD.MacroActionCommWait

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

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


Constructor Index

 o MacroActionCommWait()
Constructs an empty instance of a macro communication wait.
 o MacroActionCommWait(int, int)
Constructs a functional instance of a macro communication wait with the given parameters.

Method Index

 o execute()
Executes the comm wait action.
 o format(int, boolean)
Formats the action object's contents into a readable string.
 o getTimeout()
Returns the timeout for communication wait.
 o getWaitType()
Returns the communication type of the action.
 o halt()
Halts the action.
 o setTimeout(int)
Sets the timeout for communication wait.
 o setWaitType(int)
Sets the type of communication event.

Constructors

 o MacroActionCommWait
 public MacroActionCommWait()
Constructs an empty instance of a macro communication wait.

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

 o MacroActionCommWait
 public MacroActionCommWait(int argType,
                            int argTimeout)
Constructs a functional instance of a macro communication wait with the given parameters.

Parameters:
argType - communication type to wait for. Allowed values are defined in ECLConnection
argTimeout - timeout value for wait in milliseconds
See Also:
ECLConnection

Methods

 o execute
 public void execute()
Executes the comm wait action. Waits for a connection to be established. If a connection could not be established, the macro is stopped and a MacroErrorEvent is fired. setOwner must have been called with a Macro object that is associated with a ECLSession. Otherwise the method throws a NullPointerException

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

Overrides:
halt in class MacroAction
 o setWaitType
 public void setWaitType(int argType)
Sets the type of communication event. The default is ECLConnection.CONNECTION_READY.

Parameters:
argType - new communication wait type
 o getWaitType
 public long getWaitType()
Returns the communication type of the action.

Returns:
communication wait type for the action
 o setTimeout
 public void setTimeout(int argTimeout)
Sets the timeout for communication wait.

Parameters:
argTimeout - new timeout value
 o getTimeout
 public long getTimeout()
Returns the timeout for communication wait.

Returns:
timeout value for the wait
 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 formatted also
Returns:
formatted string that reflects the contents of the action
Overrides:
format in class MacroAction

All Packages  Class Hierarchy  This Package  Previous  Next  Index