com.ibm.eNetwork.beans.HOD.event
Class MacroTickTockEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--com.ibm.eNetwork.beans.HOD.event.HODEvent
              |
              +--com.ibm.eNetwork.beans.HOD.event.MacroTickTockEvent
All Implemented Interfaces:
java.io.Serializable

public class MacroTickTockEvent
extends com.ibm.eNetwork.beans.HOD.event.HODEvent

MacroTickTockEvent is fired to MacroTickTockListeners by Macro when it is waiting for a MacroScreen in a given MacroNextScreens object to appear from the host. This event is fired every second until either a screen appears or the Macro bean times out.

See Also:
MacroTickTockListener, Macro, Serialized Form

Constructor Summary
MacroTickTockEvent(Macro src, MacroNextScreens mns, int timeTot, int timeElapsed, int timeRemain)
          Constructs a new MacroTickTockEvent object.
 
Method Summary
 int getElapsed()
          Returns the number of seconds elapsed for the next screen wait.
 MacroNextScreens getNextScreens()
          Returns the MacroNextScreens object that contains the MacroScreen objects that the Macro bean is expecting to appear from the host.
 int getRemaining()
          Returns the number of seconds remaining for the next screen wait.
 int getTotal()
          Returns the total number of seconds used for the next screen wait.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MacroTickTockEvent

public MacroTickTockEvent(Macro src,
                          MacroNextScreens mns,
                          int timeTot,
                          int timeElapsed,
                          int timeRemain)
Constructs a new MacroTickTockEvent object.
Method Detail

getNextScreens

public MacroNextScreens getNextScreens()
Returns the MacroNextScreens object that contains the MacroScreen objects that the Macro bean is expecting to appear from the host.
Returns:
com.ibm.eNetwork.beans.HOD.MacroNextScreens next screens object currently used for the screen wait

getTotal

public int getTotal()
Returns the total number of seconds used for the next screen wait.
Returns:
java.lang.int total seconds for wait

getElapsed

public int getElapsed()
Returns the number of seconds elapsed for the next screen wait.
Returns:
java.lang.int seconds elapsed so far for wait

getRemaining

public int getRemaining()
Returns the number of seconds remaining for the next screen wait.
Returns:
java.lang.int seconds remaining until Macro bean times out