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.
PREV
NEXT
FRAMES
NO FRAMES
All Classes
Serialized Form
Package com.ibm.hats.common
Class com.ibm.hats.common.ApplicationKeypadTag extends com.ibm.hats.common.HatsBaseTag implements Serializable
out
PrintWriter out
smallBtnSize
int smallBtnSize
bigBtnSize
int bigBtnSize
drawType
String drawType
keypadSettings
String keypadSettings
appProperties
Properties appProperties
layout
String layout
clientLocale
Locale clientLocale
MSG_COMPONENT
String MSG_COMPONENT
msg
com.ibm.hats.util.HatsMsgs msg
outputHTML
int outputHTML
outputCustomKeypad
int outputCustomKeypad
calledFromRuntime
int calledFromRuntime
outputType
int outputType
PrintSuport
boolean PrintSuport
codepage
int codepage
strBigBtnSize
String strBigBtnSize
strSmallBtnSize
String strSmallBtnSize
ButtonSets
String [][] ButtonSets
tInfo
TransformInfo tInfo
isIBMPortlet
boolean isIBMPortlet
isJSR168Portlet
boolean isJSR168Portlet
isJSR286Portlet
boolean isJSR286Portlet
Class com.ibm.hats.common.BidiReverseButtonTag extends com.ibm.hats.common.HatsBaseTag implements Serializable
btnSize
int btnSize
btnText
String btnText
chkboxText
String chkboxText
type
String type
disabled
boolean disabled
tagProperties
Properties tagProperties
tagSettings
String tagSettings
clientLocale
Locale clientLocale
MSG_COMPONENT
String MSG_COMPONENT
msg
com.ibm.hats.util.HatsMsgs msg
codepage
int codepage
isVerticalLayout
boolean isVerticalLayout
Class com.ibm.hats.common.CSSOverridesMap extends HashMap implements Serializable
Class com.ibm.hats.common.DBCSSettings extends com.ibm.hats.common.IDBCSSettings implements Serializable
isRcpProject
boolean isRcpProject
Class com.ibm.hats.common.FormTag extends com.ibm.hats.common.HatsBaseTag implements Serializable
serialVersionUID: -6932563662949008822L
codepage
int codepage
is5250
boolean is5250
ischkRTB
boolean ischkRTB
enableKeyboardLayerSwitch
boolean enableKeyboardLayerSwitch
level
int level
createform
boolean createform
createhidden
boolean createhidden
createjs
boolean createjs
createinclude
boolean createinclude
sessID
String sessID
ScreenOrientation
String ScreenOrientation
hatsportletid
String hatsportletid
rewriteParams
String rewriteParams
enableBrowserGUIMirroring
boolean enableBrowserGUIMirroring
_type
String _type
ignoreOIA
boolean ignoreOIA
kbdOverride
boolean kbdOverride
kbdSupportAllKeys
boolean kbdSupportAllKeys
Class com.ibm.hats.common.HatsBaseTag extends javax.servlet.jsp.tagext.BodyTagSupport implements Serializable
formID
String formID
comment
boolean comment
skipbody
boolean skipbody
skipbodyset
boolean skipbodyset
dir_in
boolean dir_in
Class com.ibm.hats.common.HATSComponentTag extends com.ibm.hats.common.HatsBaseTag implements Serializable
session
javax.servlet.http.HttpSession session
request
javax.servlet.http.HttpServletRequest request
response
javax.servlet.http.HttpServletResponse response
out
javax.servlet.jsp.JspWriter out
widget
String widget
type
String type
dynamicRegion
String dynamicRegion
row
int row
col
int col
erow
int erow
ecol
int ecol
label
String label
componentSettings
String componentSettings
widgetSettings
String widgetSettings
root
String root
relativePath
String relativePath
bgroot
String bgroot
markup
String markup
scriptLanguage
String scriptLanguage
textReplacement
String textReplacement
applyGlobalRules
boolean applyGlobalRules
applyTextReplacement
boolean applyTextReplacement
alternate
String alternate
alternateRenderingSet
String alternateRenderingSet
BIDIOpposite
String BIDIOpposite
componentIdentifier
String componentIdentifier
clientLocale
Locale clientLocale
MSG_COMPONENT
String MSG_COMPONENT
msg
com.ibm.hats.util.HatsMsgs msg
Class com.ibm.hats.common.HatsException extends Exception implements Serializable
Class com.ibm.hats.common.HatsGlobalVariableTag extends com.ibm.hats.common.HatsBaseTag implements Serializable
name
String name
value
String value
Class com.ibm.hats.common.HatsIncludeTemplateTag extends javax.servlet.jsp.tagext.TagSupport implements Serializable
templatePath
String templatePath
Class com.ibm.hats.common.HatsTransformTag extends com.ibm.hats.common.HatsBaseTag implements Serializable
Class com.ibm.hats.common.HatsUtilTag extends javax.servlet.jsp.tagext.TagSupport implements Serializable
type
String type
settings
String settings
Class com.ibm.hats.common.HostKeypadTag extends com.ibm.hats.common.HatsBaseTag implements Serializable
smallBtnSize
int smallBtnSize
bigBtnSize
int bigBtnSize
drawType
String drawType
out
PrintWriter out
keypadSettings
String keypadSettings
appProperties
Properties appProperties
HostPFKey
String HostPFKey
clientLocale
Locale clientLocale
msg
com.ibm.hats.util.HatsMsgs msg
studioMsg
com.ibm.hats.util.HatsMsgs studioMsg
strBigBtnSize
String strBigBtnSize
strSmallBtnSize
String strSmallBtnSize
cols_in_Row
int cols_in_Row
NOT_FOUND
int NOT_FOUND
iOption
int iOption
iEnter
int iEnter
iReset
int iReset
ButtonSetsRow3
String [][] ButtonSetsRow3
ButtonSetsRow4
String [][] ButtonSetsRow4
ButtonSetsRow5
String [][] ButtonSetsRow5
nonPFkeySets
Object [] nonPFkeySets
Class com.ibm.hats.common.HpMigrationException extends com.ibm.hats.common.HatsException implements Serializable
Class com.ibm.hats.common.IDBCSSettings extends Properties implements Serializable
Class com.ibm.hats.common.OIATag extends com.ibm.hats.common.HatsBaseTag implements Serializable
props
Properties props
Class com.ibm.hats.common.PrintButtonTag extends com.ibm.hats.common.HatsBaseTag implements Serializable
btnSize
int btnSize
btnText
String btnText
type
String type
url
String url
handler
com.ibm.hats.runtime.PrintResourceHandler handler
disabled
boolean disabled
tagProperties
Properties tagProperties
tagSettings
String tagSettings
clientLocale
Locale clientLocale
MSG_COMPONENT
String MSG_COMPONENT
msg
com.ibm.hats.util.HatsMsgs msg
Class com.ibm.hats.common.ScreenAggregate extends ArrayList implements Serializable
component
Component component
componentSettings
Properties componentSettings
reco
String reco
globalRules
com.ibm.hats.transform.AbstractRenderingRulesEngine globalRules
Class com.ibm.hats.common.ScreenCommandContainer extends ArrayList implements Serializable
Class com.ibm.hats.common.StringableProperties extends Properties implements Serializable
Class com.ibm.hats.common.VCTStylesLinkTag extends javax.servlet.jsp.tagext.TagSupport implements Serializable
Package com.ibm.hats.common.customlogic
bli
IBusinessLogicInformation bli
Our private storage of the business logic object.
HHCRL
HatsHpCustomListener HHCRL
Out pre-made Host Publisher custom logic custom listener.
isRTlAndIsRTLSaved
boolean isRTlAndIsRTLSaved
See Also: ECLCustomRecoListener
isRTlAndIsRTLSaved
boolean isRTlAndIsRTLSaved
BIDI Reverse.
debugON
boolean debugON
Boolean for whether in debug mode or not.
loopScreenCounts
Hashtable loopScreenCounts
Hashtable holding the count of screens in the loop.
loopIterationCount
int loopIterationCount
int loop iteration counter,tracks iteration count via Custom Action. Reset to 0 when loop complete
Package com.ibm.hats.runtime
Class com.ibm.hats.runtime.ApplicationUnavailableException extends Exception implements Serializable
Class com.ibm.hats.runtime.AppManager extends Hashtable implements Serializable
Class com.ibm.hats.runtime.AsynchPageServlet extends javax.servlet.http.HttpServlet implements Serializable
Class com.ibm.hats.runtime.CalendarServlet extends javax.servlet.http.HttpServlet implements Serializable
serialVersionUID: 1054081688584718104L
monthNameFormatter
SimpleDateFormat monthNameFormatter
fullFormatter
DateFormat fullFormatter
context
IContext context
webConfig
IConfig webConfig
Class com.ibm.hats.runtime.EntryServlet extends javax.servlet.http.HttpServlet implements Serializable
config
IConfig config
serviceManager
IServiceManager serviceManager
appService
IApplicationService appService
applicationId
String applicationId
Class com.ibm.hats.runtime.EventStack extends Stack implements Serializable
Class com.ibm.hats.runtime.Fast3270ENSB extends com.ibm.hats.runtime.NextScreenBean implements Serializable
minimumWait
long minimumWait
Class com.ibm.hats.runtime.Fast5250NSB extends com.ibm.hats.runtime.TimingNextScreenBean implements Serializable
psSize
int psSize
checkForShortcut
boolean checkForShortcut
interruptedWait
boolean interruptedWait
oiaState
long oiaState
psStart
int psStart
psEnd
int psEnd
minimumWait
long minimumWait
Class com.ibm.hats.runtime.HostConnectionException extends Exception implements Serializable
Class com.ibm.hats.runtime.HttpSessionWatcher extends Object implements Serializable
root
String root
Class com.ibm.hats.runtime.NextScreenBean extends Object implements Serializable
hodSession
Session hodSession
eclPS
ECLPS eclPS
hostScreen
HostScreen hostScreen
hostSession
com.ibm.hats.common.connmgr.HodPoolSpec hostSession
insertionPoint
int insertionPoint
keyToSend
String keyToSend
nonHostKeyWait
long nonHostKeyWait
timeToWaitOriginal
long timeToWaitOriginal
timeStartedWaiting
long timeStartedWaiting
timeLastPSEvent
long timeLastPSEvent
initialConnect
boolean initialConnect
appletHandling
boolean appletHandling
Class com.ibm.hats.runtime.PrintJobDeleteAllButtonTag extends javax.servlet.jsp.tagext.TagSupport implements Serializable
Class com.ibm.hats.runtime.PrintJobListTag extends javax.servlet.jsp.tagext.TagSupport implements Serializable
Class com.ibm.hats.runtime.PrintLUNameTag extends javax.servlet.jsp.tagext.TagSupport implements Serializable
Class com.ibm.hats.runtime.PrintSessionConnectionTag extends javax.servlet.jsp.tagext.TagSupport implements Serializable
Class com.ibm.hats.runtime.RestServlet extends javax.servlet.http.HttpServlet implements Serializable
serialVersionUID: 1L
restMap
com.ibm.hats.common.RestMappingHandler restMap
Class com.ibm.hats.runtime.SimpleWaitNextScreenBean extends com.ibm.hats.runtime.NextScreenBean implements Serializable
Class com.ibm.hats.runtime.SpreadsheetGeneratorServlet extends javax.servlet.http.HttpServlet implements Serializable
startCol
int startCol
startRow
int startRow
endCol
int endCol
endRow
int endRow
filename
String filename
extname
String extname
component
String component
clientEncoding
String clientEncoding
fullname
String fullname
columnBreak
String columnBreak
numOfTitleRows
int numOfTitleRows
includeEmptyRows
String includeEmptyRows
excludedRows
String excludedRows
excludedCols
String excludedCols
minRows
String minRows
minCols
String minCols
prevlineheader
String prevlineheader
tableIndex
String tableIndex
isInDefaultRendering
boolean isInDefaultRendering
portletID
String portletID
ltrWidgetOrientation
boolean ltrWidgetOrientation
dirTextEnabled
boolean dirTextEnabled
rtlScreen
boolean rtlScreen
Class com.ibm.hats.runtime.TimingNextScreenBean extends com.ibm.hats.runtime.NextScreenBean implements Serializable
psEventSynchObj
Object psEventSynchObj
isPSListener
boolean isPSListener
isOIAListener
boolean isOIAListener
timeToWaitCurrent
long timeToWaitCurrent
timeMidwayPoint
long timeMidwayPoint
isWaitAgain
boolean isWaitAgain
Class com.ibm.hats.runtime.WatcherBean extends Object implements Serializable
notInhibited
boolean notInhibited
_pschange
int _pschange
_oiachange
int _oiachange
_commchange
int _commchange
flag
int flag
Package com.ibm.hats.transform
Class com.ibm.hats.transform.CompactTableDataObject extends com.ibm.hats.transform.TableDataObject implements Serializable
serialVersionUID: 7102550745576676774L
Class com.ibm.hats.transform.CompactTableObject extends com.ibm.hats.transform.TableObject implements Serializable
serialVersionUID: 6034800344033092306L
Class com.ibm.hats.transform.CompactTableRowObject extends com.ibm.hats.transform.TableRowObject implements Serializable
serialVersionUID: 1536116034510820747L
Class com.ibm.hats.transform.DefaultRenderingTag extends com.ibm.hats.common.HatsBaseTag implements Serializable
renderingSet
String renderingSet
startRow
int startRow
startCol
int startCol
endRow
int endRow
endCol
int endCol
applyGlobalRules
boolean applyGlobalRules
applyTextReplacement
boolean applyTextReplacement
settings
String settings
body
String body
Class com.ibm.hats.transform.FLMTableDataObject extends com.ibm.hats.transform.TableDataObject implements Serializable
isFLMCell
boolean isFLMCell
Class com.ibm.hats.transform.FLMTableObject extends com.ibm.hats.transform.TableObject implements Serializable
bidiWidgetReversed
boolean bidiWidgetReversed
Class com.ibm.hats.transform.FLMTableRowObject extends com.ibm.hats.transform.TableRowObject implements Serializable
serialVersionUID: 7716023908189152558L
name
String name
description
String description
layout
String layout
alignment
String alignment
Class com.ibm.hats.transform.TableDataObject extends Vector implements Serializable
area
BlockScreenRegion area
defaultRenderingSettings
Properties defaultRenderingSettings
tableCellStyleClassName
String tableCellStyleClassName
tableCellStyles
String tableCellStyles
nowrap
boolean nowrap
closeTag
boolean closeTag
useWrappingTableData
boolean useWrappingTableData
Class com.ibm.hats.transform.TableObject extends Vector implements Serializable
area
BlockScreenRegion area
defaultRenderingSettings
Properties defaultRenderingSettings
tableStyleClassName
String tableStyleClassName
hostScreen
HsrScreen hostScreen
includeSpacerRow
boolean includeSpacerRow
border
int border
Class com.ibm.hats.transform.TableRowObject extends Vector implements Serializable
defaultRenderingSettings
Properties defaultRenderingSettings
tableRowStyleClassName
String tableRowStyleClassName
closeTag
boolean closeTag
renderingItemAlignment
String renderingItemAlignment
Package com.ibm.hats.transform.context
Class com.ibm.hats.transform.context.StudioContextAttributes extends ContextAttributes implements Serializable
Package com.ibm.hats.transform.regions
Class com.ibm.hats.transform.regions.RegionManager extends Vector implements Serializable
outerBoundary
ScreenRegion outerBoundary
hs
HsrScreen hs
traverseTreeOnContention
boolean traverseTreeOnContention
counter
int counter
avail
short[] avail
Package com.ibm.hats.util
Class com.ibm.hats.util.HATSFormatter extends com.ibm.logging.Formatter implements Serializable
serialVersionUID: 7754156534580001328L
posTraceMethod
int posTraceMethod
posComponent
int posComponent
posClassMethod
int posClassMethod
posTime
int posTime
posDate
int posDate
posThread
int posThread
Class com.ibm.hats.util.HATSLogger extends com.ibm.logging.Logger implements Serializable
serialVersionUID: -7254910426228130817L
Class com.ibm.hats.util.HATSLogRecord extends Hashtable implements Serializable
serialVersionUID: 6753331339018214543L
type
long type
traceMethod
String traceMethod
timeStamp
long timeStamp
nextRecord
com.ibm.logging.ILogRecord nextRecord
msgFile
String msgFile
msgText
String msgText
msgParms
String [] msgParms
addIdfs
Hashtable addIdfs
Class com.ibm.hats.util.HODWatcher extends Object implements Serializable
isListeningPS
boolean isListeningPS
isListeningOIA
boolean isListeningOIA
isListeningComm
boolean isListeningComm
isListeningTrace
boolean isListeningTrace
notInhibited
boolean notInhibited
_pschange
int _pschange
_oiachange
int _oiachange
_commchange
int _commchange
flag
int flag
connMgr
com.ibm.hats.runtime.connmgr.ConnMgr connMgr
isSessionTraceListener
boolean isSessionTraceListener
isPSEventListener
boolean isPSEventListener
isOIAEventListener
boolean isOIAEventListener
isCommEventListener
boolean isCommEventListener
sessionBean
Session sessionBean
specialID
String specialID
isMacroTraceListener
boolean isMacroTraceListener
macroBean
com.ibm.hats.common.HMacro macroBean
identifierString
String identifierString
Class com.ibm.hats.util.InvalidArgumentException extends Exception implements Serializable
Class com.ibm.hats.util.InvalidResultException extends Exception implements Serializable
Class com.ibm.hats.util.OrderedHashtable extends Hashtable implements Serializable
orderedEntries
Vector orderedEntries
Class com.ibm.hats.util.RasLicMessageFormatter extends com.ibm.logging.Formatter implements Serializable
locale
Locale locale
Package com.ibm.HostPublisher.IntegrationObject
exceptionType
int exceptionType
linkedThrowable
Throwable linkedThrowable
Class com.ibm.HostPublisher.IntegrationObject.HAOVariable extends Object implements Serializable
stringPromptName
String stringPromptName
stringExtractName
String stringExtractName
stringVariableName
String stringVariableName
booleanInputVariable
boolean booleanInputVariable
stringValue
String stringValue
intXLocation
int intXLocation
intYLocation
int intYLocation
intXDelta
int intXDelta
intYDelta
int intYDelta
intXScreenLocation
int intXScreenLocation
intYScreenLocation
int intYScreenLocation
oMultiValues
Vector oMultiValues
oStringArray
String [] oStringArray
intVariableType
int intVariableType
hPubXMLProperties
String hPubXMLProperties
hPubXMLPropertiesWithoutInvoking
String hPubXMLPropertiesWithoutInvoking
hPubDebugLevel
int hPubDebugLevel
oHPConnMgr
com.ibm.hats.runtime.connmgr.ConnMgr oHPConnMgr
hPubStartType
int hPubStartType
Indicates whether the connection for the Integration Object was obtained
from a pool or a chain
hPubEndType
int hPubEndType
Indicates whether the Integration Object will be returned to the pool or saved
for the next Integration Object in the chain
hPubStartPoolName
String hPubStartPoolName
The connection pool from which the Integration Object obtained the connection from
hPubConnectionOverrides
Properties hPubConnectionOverrides
The connection overrides to apply when establishing the connection
hPubStartChainName
String hPubStartChainName
The start state label for the Integration Object
hPubEndChainName
String hPubEndChainName
The stop state label for the Integration Object
hPubSaveConnOnError
boolean hPubSaveConnOnError
An indicator in the Integration Object that specifies whether
the connection should be destroyed if an error is detected while
executing the Integration Object
hPubErrorPage
String hPubErrorPage
Deprecated.
hPubCompleteErrorPagePath
String hPubCompleteErrorPagePath
Deprecated.
hPubErrorException
Exception hPubErrorException
If HPubErrorOccurred, returns the exception object that describes the error that occurred
hPubErrorOccurred
int hPubErrorOccurred
Returns a non-zero value when an error has occurred
hPubErrorMessage
String hPubErrorMessage
Returns a string containing the HATS code and message of the error that occurred; valid only
if HPubErrorOccurred is non-zero
hPubLinkKey
String hPubLinkKey
The name of the key that represents the connection for the Integration Object chain
hPubBeanName
String hPubBeanName
The name of the current Integration Object or EJB Access Bean
hPubBeanType
String hPubBeanType
Represents the type of Integration Object or EJB Access Bean. Can be one of the following:
HOD The bean was created using Host Publisher Host Access or HATS Studio
DB This bean was created using Host Publisher Database Access
hPubAccessHandle
String hPubAccessHandle
styleSheet
String styleSheet
xmlData
String xmlData
hPubSqlString
String hPubSqlString
Deprecated.
hPubCon
Connection hPubCon
Deprecated.
hPubDBStatement
Statement hPubDBStatement
Deprecated.
hPubWarningOccurred
int hPubWarningOccurred
Deprecated. A non-zero value indicates that a warning has occurred
hPubSQLErrorException
SQLException hPubSQLErrorException
Deprecated. SQL Exception object of the error that occurred; valid only if HPubErrorOccurred is non-zero and HPubErrorMessage indicates an SQL error.
hPubSQLWarningException
SQLWarning hPubSQLWarningException
Deprecated. SQLWarning object of the warning that occurred; valid only if HPubWarningOccurred is non-zero.
intMacroState
int intMacroState
booleanFirstTimeHere
boolean booleanFirstTimeHere
useAccentedCharacters
boolean useAccentedCharacters
macroBean
Macro macroBean
sessionHost
Session sessionHost
stringMacroName
String stringMacroName
intCodePage
int intCodePage
stringCodePage
String stringCodePage
booleanDBCSCodePageInUse
boolean booleanDBCSCodePageInUse
booleanSetAllPromptsInitially
boolean booleanSetAllPromptsInitially
hPubScreenState
String hPubScreenState
The name of the last Host On-Demand macro screen executed when the macro was stopped
hPubMacroMessage
String hPubMacroMessage
The value of the message tag of the last screen executed in the current Host On-Demand macro screen
macroConnectionDown
boolean macroConnectionDown
waitForDisconnect
boolean waitForDisconnect
is5250
boolean is5250
isVT
boolean isVT
isArabic
boolean isArabic
isSS
boolean isSS
isNS
boolean isNS
is_rtl_prompt
boolean is_rtl_prompt
invoke_prompt_reordering
boolean invoke_prompt_reordering
invoke_extract_reordering
boolean invoke_extract_reordering
invoke_prompt_textOrientation
boolean invoke_prompt_textOrientation
invoke_extract_textOrientation
boolean invoke_extract_textOrientation
invoke_preventBidiRoundTrip
boolean invoke_preventBidiRoundTrip
Class com.ibm.HostPublisher.IntegrationObject.HPubStartEvent extends EventObject implements Serializable
Class com.ibm.HostPublisher.IntegrationObject.RequestCompleteEvent extends EventObject implements Serializable