All Packages  Class Hierarchy  This Package  Previous  Next  Index

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

java.lang.Object
   |
   +----java.util.EventObject
           |
           +----com.ibm.eNetwork.beans.HOD.event.HODEvent
                   |
                   +----com.ibm.eNetwork.beans.HOD.event.MacroPromptEvent

public class MacroPromptEvent
extends HODEvent
MacroPromptEvent is fired to MacroRuntimeListeners by Macro when it encounters a prompt line in the macro and needs data for that prompt. Use the getPrompts() method to obtain the data that Macro needs. Fill in this data by calling the appropriate methods on the MacroPrompts object. Once you have filled in the prompt data, you may call setPrompts() from this class or you may call it from the Macro class.

See Also:
MacroRuntimeListener, MacroPrompts, Macro

Constructor Index

 o MacroPromptEvent(Macro, MacroPrompts)
Constructs a new MacroPromptEvent object.

Method Index

 o getCancel()
Returns the Cancel flag which halts the macro upon return from the event handler.
 o getPrompts()
Retrieve the MacroPrompts object from the event.
 o setCancel(boolean)
Set the Cancel flag to halt the macro upon return from the event handler.
 o setPrompts(MacroPrompts)
Set the MacroPrompts object on the Macro object that initially fired the MacroPromptEvent.

Constructors

 o MacroPromptEvent
 public MacroPromptEvent(Macro src,
                         MacroPrompts p)
Constructs a new MacroPromptEvent object.

Methods

 o getPrompts
 public MacroPrompts getPrompts()
Retrieve the MacroPrompts object from the event.

Returns:
MacroPrompts object that needs to be filled in for Macro to finish running.
See Also:
MacroPrompts
 o setPrompts
 public void setPrompts(MacroPrompts p) throws MacroException
Set the MacroPrompts object on the Macro object that initially fired the MacroPromptEvent. This will starting running the macro again. This does not set MacroPrompts in this object. The user can set prompts value for any prompt id using setPromptValue in the MacroPrompts object. This value, if non-null, will be used during when the prompt is encountered during play.

Parameters:
p - MacroPrompts object that has been filled in with the appropriate responses.
Throws: MacroException
Thrown if a parameter is passed that is not valid or if Macro experiences an internal error.
See Also:
MacroPrompts
 o setCancel
 public void setCancel(boolean cancel)
Set the Cancel flag to halt the macro upon return from the event handler.

Parameters:
cancel - If true, the macro stops playing upon return from the prompt event handler. If false (default) the macro continues.
See Also:
getCancel, MacroPrompts
 o getCancel
 public boolean getCancel()
Returns the Cancel flag which halts the macro upon return from the event handler.

See Also:
setCancel, MacroPrompts

All Packages  Class Hierarchy  This Package  Previous  Next  Index