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 HPubHODCommonBIDI

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

public abstract class HPubHODCommonBIDI
extends HPubHODCommon

HPubHODCommonBIDI extends HPubHODCommon. It is a class for bidirectional IOs that enables the developer to specify whether text output by the Integration Object should be reordered

See Also:
Serialized Form

Field Summary
static String LTR_LABEL
           
static String RTL_LABEL
           
 
Fields inherited from class com.ibm.HostPublisher.IntegrationObject.HPubHODCommon
DBCSCodePages, hPubMacroMessage, hPubScreenState, MACRO_STATE_INSTANTIATED, MACRO_STATE_NOT_INSTANTIATED, MACRO_STATE_PARSE_ERROR, MACRO_STATE_PLAY_FINISHED, MACRO_STATE_PLAYING, 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
HPubHODCommonBIDI()
           
 
Method Summary
 String GetExtractDir(String name)
          Rteurns whether an extract is rtl or ltr.
 String getExtractReordering()
          Returns whether data retrieved from an Extract action should be reordered
 String getExtractRTLTextOrientation()
          Returns whether data retrieved from an Extract action should be displayed in Right To Left Direction
 String getPreventBidiRoundTrip()
          Returns whether data retrieved from an Extract action should include markers to prevent a round-trip problem.
 String getPromptReordering()
          Returns whether data retrieved from a Prompt action should be reordered
 String getPromptRTLTextOrientation()
          Returns whether data retrieved from a Prompt action should be displayed in Right To Left Direction
 boolean isRTLExtract(String name)
          Returns whether the extract is rtl.
static String preventRoundTrip(String str)
           
static String preventRoundTrip(String str, boolean reverse)
           
static String processNumSwap(String s)
           
static String processSymSwap(String s)
           
 void setExtractReordering(String v)
          Sets whether data retrieved from an Extract action should be reordered
 void setExtractRTLTextOrientation(String v)
          Sets whether data retrieved from an Extract action should be displayed in Right To Left Direction
 void setPreventBidiRoundTrip(String v)
          Sets whether data retrieved from an Extract action should include markers to prevent a round-trip problem.
 void setPromptReordering(String v)
          Sets whether data retrieved from a Prompt action should be reordered
 void setPromptRTLTextOrientation(String v)
          Sets whether data retrieved from a Prompt action should be displayed in Right To Left Direction
 
Methods inherited from class com.ibm.HostPublisher.IntegrationObject.HPubHODCommon
finalize, getHPubMacroMessage, getHPubScreenState, setHPubScreenState
 
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

LTR_LABEL

public static String LTR_LABEL

RTL_LABEL

public static String RTL_LABEL
Constructor Detail

HPubHODCommonBIDI

public HPubHODCommonBIDI()
Method Detail

setPreventBidiRoundTrip

public void setPreventBidiRoundTrip(String v)
Sets whether data retrieved from an Extract action should include markers to prevent a round-trip problem.

Parameters:
v - should be set to true or false depending upon whether the data from an extract action should be reordered

getPreventBidiRoundTrip

public String getPreventBidiRoundTrip()
Returns whether data retrieved from an Extract action should include markers to prevent a round-trip problem.

Returns:
true or false depending upon whether the data from an extract action should be reordered

setPromptReordering

public void setPromptReordering(String v)
Sets whether data retrieved from a Prompt action should be reordered

Parameters:
v - should be set to true or false depending upon whether the data from a prompt action should be reordered

getPromptReordering

public String getPromptReordering()
Returns whether data retrieved from a Prompt action should be reordered

Returns:
true or false depending upon whether the data from a prompt action should be reordered

setExtractReordering

public void setExtractReordering(String v)
Sets whether data retrieved from an Extract action should be reordered

Parameters:
v - should be set to true or false depending upon whether the data from an extract action should be reordered

getExtractReordering

public String getExtractReordering()
Returns whether data retrieved from an Extract action should be reordered

Returns:
true or false depending upon whether the data from an extract action should be reordered

setPromptRTLTextOrientation

public void setPromptRTLTextOrientation(String v)
Sets whether data retrieved from a Prompt action should be displayed in Right To Left Direction

Parameters:
v - should be set to true or false depending upon whether the data from a prompt action should has Right To Left Direction

getPromptRTLTextOrientation

public String getPromptRTLTextOrientation()
Returns whether data retrieved from a Prompt action should be displayed in Right To Left Direction

Returns:
true or false depending upon whether the data from a prompt action should be Right To Left Direction

setExtractRTLTextOrientation

public void setExtractRTLTextOrientation(String v)
Sets whether data retrieved from an Extract action should be displayed in Right To Left Direction

Parameters:
v - should be set to true or false depending upon whether the data from an extract action should has Right To Left Direction

getExtractRTLTextOrientation

public String getExtractRTLTextOrientation()
Returns whether data retrieved from an Extract action should be displayed in Right To Left Direction

Returns:
true or false depending upon whether the data from an extract action should be Right To Left Direction

preventRoundTrip

public static String preventRoundTrip(String str)

preventRoundTrip

public static String preventRoundTrip(String str,
                                      boolean reverse)

isRTLExtract

public boolean isRTLExtract(String name)
Returns whether the extract is rtl.

Parameters:
name - The extract to be examined.
Returns:
A boolean value indicating whether or not the extract is rtl.

GetExtractDir

public String GetExtractDir(String name)
Rteurns whether an extract is rtl or ltr.

Parameters:
name - The extract to be examined.
Returns:
The following String contents are returned based upon whether the extract direction is rtl or ltr.

"dir=rtl" if the direction is rtl.

"dir=ltr" if the direction is ltr.


processNumSwap

public static String processNumSwap(String s)

processSymSwap

public static String processSymSwap(String s)

HATS 7.5.1 (201005110649)