com.ibm.eNetwork.beans.HOD.event
Class MacroCustomActionEvent
java.lang.Object
|
+--java.util.EventObject
|
+--com.ibm.eNetwork.beans.HOD.event.HODEvent
|
+--com.ibm.eNetwork.beans.HOD.event.MacroCustomActionEvent
- All Implemented Interfaces:
- java.io.Serializable
- public class MacroCustomActionEvent
- extends com.ibm.eNetwork.beans.HOD.event.HODEvent
Event fired to objects implementing MacroCustomActionListener interface (must
call Macro.addMacroCustomActionListener).
To use this class properly, follow these steps:
- Implement the MacroCustomActionListener and add it to Macro using Macro.addMacroCustomActionListener.
- The execute method will be called for each custom action encountered.
- Get the ID of the action to make help differentiate among multiple custom actions.
- Retrieve any arguments.
- Execute any code you want to. It is wise to make your code reentrant
because the Macro bean may need to call the halt() method if an error
occurs.
- See Also:
- Serialized Form
Constructor Summary |
MacroCustomActionEvent(Macro argSrc,
java.lang.String argID,
java.lang.String argArgs)
Constructs a working instance of a MacroCustomActionEvent object. |
Method Summary |
java.lang.String |
getArgs()
Returns the arguments for the action. |
java.lang.String |
getID()
Returns ID of the custom action |
Methods inherited from class java.util.EventObject |
getSource, toString |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
MacroCustomActionEvent
public MacroCustomActionEvent(Macro argSrc,
java.lang.String argID,
java.lang.String argArgs)
- Constructs a working instance of a MacroCustomActionEvent object.
- Parameters:
argSrc
- Macro bean object that is the owner of the eventargID
- ID of the custom actionargArgs
- arguments for the custom action
getID
public java.lang.String getID()
- Returns ID of the custom action
- Returns:
- custom action ID
getArgs
public java.lang.String getArgs()
- Returns the arguments for the action.
- Returns:
- custom action arguments