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 AbstractAdvancedCustomScreenRecoListener

java.lang.Object
  extended by com.ibm.hats.common.customlogic.AbstractAdvancedCustomScreenRecoListener
All Implemented Interfaces:
ECLCustomRecoListener, com.ibm.hats.common.customlogic.IAdvancedApplicationInfoListener, com.ibm.hats.common.customlogic.IAdvancedCustomScreenRecoListener
Direct Known Subclasses:
AbstractCustomScreenRecoListener, BlankScreenScreenReco, GlobalVariableScreenReco

public abstract class AbstractAdvancedCustomScreenRecoListener
extends Object
implements com.ibm.hats.common.customlogic.IAdvancedCustomScreenRecoListener

Class Name: AbstractAdvancedCustomScreenRecoListener
Class Type:
Abstract
Base Class:
None
Intf Class:
IAdvancedCustomScreenRecoListener
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
AbstractAdvancedCustomScreenRecoListener()
           
 
Method Summary
 boolean DoReco(ECLCustomRecoEvent evt)
          Do the custom recognition.
abstract  boolean isRecognized(String settings, IBusinessLogicInformation bli, ECLPS ps, ECLScreenDesc screenDescription)
          Evaluates the claim of screen recognition for the descriptor given.
 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

AbstractAdvancedCustomScreenRecoListener

public AbstractAdvancedCustomScreenRecoListener()
Method Detail

DoReco

public boolean DoReco(ECLCustomRecoEvent evt)
Do the custom recognition.

Specified by:
DoReco in interface ECLCustomRecoListener
Parameters:
evt - Host On Demand custom screen reco event object.
Returns:
True if recognized, false otherwise.

See Also:
MacroCustomActionEvent, ECLCustomRecoListener.DoReco( com.ibm.eNetwork.ECL.screenreco.event.ECLCustomRecoEvent )

isRecognized

public abstract boolean isRecognized(String settings,
                                     IBusinessLogicInformation bli,
                                     ECLPS ps,
                                     ECLScreenDesc screenDescription)
Evaluates the claim of screen recognition for the descriptor given.

Parameters:
settings - Settings from the custom screen reco event.
bli - HATS Business logic object.
ps - Host On Demand host Screen representation.
screenDescription - Host On Demand Screen Description object.
Returns:
Whether or not the screen is recognized

setApplicationInfo

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

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

HATS 7.5.1 (201005110649)