HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.common.customlogic
Class AbstractAdvancedCustomMacroActionListener

java.lang.Object
  extended by com.ibm.hats.common.customlogic.AbstractAdvancedCustomMacroActionListener
All Implemented Interfaces:
MacroCustomActionListener, com.ibm.hats.common.customlogic.IAdvancedApplicationInfoListener, com.ibm.hats.common.customlogic.IAdvancedCustomMacroActionListener, EventListener
Direct Known Subclasses:
AbstractCustomMacroActionListener

public abstract class AbstractAdvancedCustomMacroActionListener
extends Object
implements com.ibm.hats.common.customlogic.IAdvancedCustomMacroActionListener

Class Name: AbstractAdvancedCustomMacroActionListener
Class Type:
Abstract
Base Class:
None
Intf Class:
IAdvancedCustomMacroActionListener
Description:
Separates APIs by version. This class is the new class that should be extended directly starting with HATS 7.0.0.1

Since:
7.0.0.1


Constructor Summary
AbstractAdvancedCustomMacroActionListener()
           
 
Method Summary
 void execute(MacroCustomActionEvent evt)
          This method allows for the execution of the custom action.
 void halt(MacroCustomActionEvent evt)
          This method allows for the stop, if possible, of the custom action.
abstract  boolean pauseLogic(String settings, IBusinessLogicInformation businessLogic)
          This abstract method allows for the pause, if possible, of the custom action.
abstract  boolean runLogic(String settings, IBusinessLogicInformation businessLogic)
          This abstract method defines the run logic action.
 void setApplicationInfo(IBusinessLogicInformation bli)
          Set the application information.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractAdvancedCustomMacroActionListener

public AbstractAdvancedCustomMacroActionListener()
Method Detail

execute

public void execute(MacroCustomActionEvent evt)
This method allows for the execution of the custom action.

Specified by:
execute in interface MacroCustomActionListener
Parameters:
evt - The MacroCustomActionEvent object.
See Also:
MacroCustomActionListener.execute( MacroCustomActionEvent )

halt

public void halt(MacroCustomActionEvent evt)
This method allows for the stop, if possible, of the custom action.

Specified by:
halt in interface MacroCustomActionListener
Parameters:
evt - The MacroCustomActionEvent object.
See Also:
MacroCustomActionListener.halt( MacroCustomActionEvent )

pauseLogic

public abstract boolean pauseLogic(String settings,
                                   IBusinessLogicInformation businessLogic)
This abstract method allows for the pause, if possible, of the custom action.

Parameters:
settings - These are the arguments to the action, equivalent to the MacroCustomActionEvent.getArgs() method.
businessLogic - The HATS business logic.
Returns:
Returns success or failure of the method run.
See Also:
MacroCustomActionEvent.getArgs()

runLogic

public abstract boolean runLogic(String settings,
                                 IBusinessLogicInformation businessLogic)
This abstract method defines the run logic action.

Parameters:
settings - These are the arguments to the action, equivalent to the MacroCustomActionEvent.getArgs() method.
businessLogic - The HATS business logic.
Returns:
Returns success or failure of the method run.
See Also:
MacroCustomActionListener.execute( com.ibm.eNetwork.beans.HOD.event.MacroCustomActionEvent ), MacroCustomActionEvent.getArgs()

setApplicationInfo

public void setApplicationInfo(IBusinessLogicInformation bli)
Set the application information. Currently not implemented.

Specified by:
setApplicationInfo in interface com.ibm.hats.common.customlogic.IAdvancedApplicationInfoListener
Parameters:
bli - The business logic information interface.

HATS 7.5.1 (201005110649)