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.HostPublisher.IntegrationObject
Class HPubHODCommon

java.lang.Object
  extended by com.ibm.HostPublisher.IntegrationObject.HPubCommon
      extended by com.ibm.HostPublisher.IntegrationObject.HPubHostAccess
          extended by com.ibm.HostPublisher.IntegrationObject.HPubHODCommon
All Implemented Interfaces:
MacroCustomActionListener, MacroParseListener, MacroRuntimeListener, TraceListener, ECLCustomRecoListener, com.ibm.HostPublisher.IntegrationObject.HPubStartListener, Serializable, Runnable, EventListener
Direct Known Subclasses:
HPubHODCommonBIDI

public abstract class HPubHODCommon
extends HPubHostAccess
implements MacroRuntimeListener, MacroCustomActionListener, MacroParseListener, TraceListener, Serializable, Runnable

HPubHODCommon extends HPubHostAccess. It implements methods specific to Host Access Integration Objects.

See Also:
Serialized Form

Field Summary
static int[] DBCSCodePages
           
 String hPubMacroMessage
          The value of the message tag of the last screen executed in the current Host On-Demand macro screen
 String hPubScreenState
          The name of the last Host On-Demand macro screen executed when the macro was stopped
static int MACRO_STATE_INSTANTIATED
           
static int MACRO_STATE_NOT_INSTANTIATED
           
static int MACRO_STATE_PARSE_ERROR
           
static int MACRO_STATE_PLAY_FINISHED
           
static int MACRO_STATE_PLAYING
           
static int MACRO_STATE_READY_TO_PLAY
           
 
Fields inherited from class com.ibm.HostPublisher.IntegrationObject.HPubCommon
BEAN_END_TO_CONNECTION, BEAN_END_TO_POOL, BEAN_START_FROM_CONNECTION, BEAN_START_FROM_POOL, ERT_EVENT, ERT_NOTHING, ERT_REDIRECT, ERT_THROW, hPubAccessHandle, hPubBeanName, hPubBeanType, hPubCompleteErrorPagePath, hPubConnectionOverrides, hPubEndChainName, hPubEndType, hPubErrorException, hPubErrorMessage, hPubErrorOccurred, hPubErrorPage, hPubLinkKey, hPubSaveConnOnError, hPubStartChainName, hPubStartPoolName, hPubStartType, styleSheet, xmlData
 
Constructor Summary
HPubHODCommon()
           
 
Method Summary
protected  void finalize()
          IMPORTANT: This method is not part of the public API for the com.ibm.HostPublisher.IntegrationObject package.
 String getHPubMacroMessage()
          Returns the value of the message tag of the last screen executed in the current Host On-Demand macro screen
 String getHPubScreenState()
          Returns the name of the last Host On-Demand macro screen executed when the macro was stopped
 void setHPubScreenState(String stringToBe)
          This method sets a HOD screen name in the Integration Object.
 
Methods inherited from class com.ibm.HostPublisher.IntegrationObject.HPubCommon
doHPTransaction, DoTheWork, getHPubAccessHandle, getHPubBeanName, getHPubBeanType, getHPubConnectionOverrides, getHPubEndChainName, getHPubEndType, getHPubErrorException, getHPubErrorMessage, getHPubErrorOccurred, getHPubErrorPage, getHPubLinkKey, getHPubSaveConnOnError, getHPubStartChainName, getHPubStartPoolName, getHPubStartType, getHPubStyleSheet, getHPubXMLData, getHPubXMLProperties, getHPubXMLProperties, isTransformConn, processRequest, setHPubAccessHandle, setHPubConnectionOverrides, setHPubConnectionOverrides, setHPubEndChainName, setHPubErrorPage, setHPubLinkKey, setHPubSaveConnOnError, setHPubStartChainName, setHPubStartPoolName, setHPubStyleSheet, setHPubXMLData
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.eNetwork.beans.HOD.event.MacroRuntimeListener
macroErrorEvent, macroExtractEvent, macroMessageEvent, macroPromptEvent, macroStateEvent, macroTraceEvent
 
Methods inherited from interface com.ibm.eNetwork.beans.HOD.event.MacroCustomActionListener
execute, halt
 
Methods inherited from interface com.ibm.eNetwork.beans.HOD.event.MacroParseListener
parseFailed, parsePassed
 
Methods inherited from interface com.ibm.eNetwork.beans.HOD.trace.TraceListener
traceEvent
 
Methods inherited from interface java.lang.Runnable
run
 
Methods inherited from interface com.ibm.HostPublisher.IntegrationObject.HPubStartListener
hPubStartPerformed
 
Methods inherited from interface com.ibm.eNetwork.ECL.screenreco.event.ECLCustomRecoListener
DoReco
 

Field Detail

MACRO_STATE_NOT_INSTANTIATED

public static final int MACRO_STATE_NOT_INSTANTIATED
See Also:
Constant Field Values

MACRO_STATE_INSTANTIATED

public static final int MACRO_STATE_INSTANTIATED
See Also:
Constant Field Values

MACRO_STATE_READY_TO_PLAY

public static final int MACRO_STATE_READY_TO_PLAY
See Also:
Constant Field Values

MACRO_STATE_PLAYING

public static final int MACRO_STATE_PLAYING
See Also:
Constant Field Values

MACRO_STATE_PARSE_ERROR

public static final int MACRO_STATE_PARSE_ERROR
See Also:
Constant Field Values

MACRO_STATE_PLAY_FINISHED

public static final int MACRO_STATE_PLAY_FINISHED
See Also:
Constant Field Values

hPubScreenState

public String hPubScreenState
The name of the last Host On-Demand macro screen executed when the macro was stopped


hPubMacroMessage

public String hPubMacroMessage
The value of the message tag of the last screen executed in the current Host On-Demand macro screen


DBCSCodePages

public static final int[] DBCSCodePages
Constructor Detail

HPubHODCommon

public HPubHODCommon()
Method Detail

getHPubScreenState

public String getHPubScreenState()
Returns the name of the last Host On-Demand macro screen executed when the macro was stopped

Specified by:
getHPubScreenState in class HPubHostAccess
Returns:
the name of the last Host On-Demand macro screen executed

setHPubScreenState

public void setHPubScreenState(String stringToBe)
This method sets a HOD screen name in the Integration Object. However, the screen name should only be retrieved from the Integration Object- not set.

IMPORTANT: This method is not part of the public API for the com.ibm.HostPublisher.IntegrationObject package. It is marked public only so that it can be shared within the packages provided by HATS. It should never be called from application code.

Specified by:
setHPubScreenState in class HPubHostAccess
Parameters:
stringToBe - screen name

getHPubMacroMessage

public String getHPubMacroMessage()
Returns the value of the message tag of the last screen executed in the current Host On-Demand macro screen

Specified by:
getHPubMacroMessage in class HPubHostAccess
Returns:
the value of the message tag of the last screen executed

finalize

protected void finalize()
IMPORTANT: This method is not part of the public API for the com.ibm.HostPublisher.IntegrationObject package. It is marked public only so that it can be shared within the packages provided by HATS. It should never be called from application code.

Overrides:
finalize in class Object

HATS 7.5.1 (201005110649)