All Packages  Class Hierarchy  This Package  Previous  Next  Index

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

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

public class MacroCustomActionEvent
extends HODEvent
Event fired to objects implementing MacroCustomActionListener interface (must call Macro.addMacroCustomActionListener).

To use this class properly, follow these steps:

  1. Implement the MacroCustomActionListener and add it to Macro using Macro.addMacroCustomActionListener.
  2. The execute method will be called for each cutom action encountered.
  3. Get the ID of the action to make help differentiate among multiple custom actions.
  4. Retreive any arguments.
  5. 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.


Constructor Index

 o MacroCustomActionEvent(Macro, String, String)
Constructs a working instance of a MacroCustomActionEvent object.

Method Index

 o getArgs()
Returns the arguments for the action.
 o getID()
Returns ID of the custom action

Constructors

 o MacroCustomActionEvent
 public MacroCustomActionEvent(Macro argSrc,
                               String argID,
                               String argArgs)
Constructs a working instance of a MacroCustomActionEvent object.

Parameters:
argSrc - Macro bean object that is the owner of the event
argID - ID of the custom action
argArgs - arguments for the custom action

Methods

 o getID
 public String getID()
Returns ID of the custom action

Returns:
custom action ID
 o getArgs
 public String getArgs()
Returns the arguments for the action.

Returns:
custom action arguments

All Packages  Class Hierarchy  This Package  Previous  Next  Index