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.

Package com.ibm.hats.common

Interface Summary
IBaseInfo Class Name: IBaseInfo
Class Type:
Interface
Base Class:
None
Intf Class:
None
Description:
The interface parent class for all information objects.
IBusinessLogicInformation Class Name: IBusinessLogicInformation
Class Type:
Interface
Base Class:
IBaseInfo
Intf Class:
None
Description:
The interface for an information object that is passed to custom BusinessLogic classes during an execute action which is invoked at runtime.
IContextDependent IContextDependent is an interface which allows Components or Widgets to programatically exclude themselves or their settings from view in the studio.
ICustomPropertySupplier Interface to provide information about user customizable settings for an object, along with the details on how to display them so they can be configured.
ICustomPropertyValidator Validation interface used by Component and Widget in the studio GUI if they do not override the ICustomPropertySupplier.getCustomComposite() function.
IGlobalVariable A Global Variable is an object which can be the target of SetAction, ExtractAction, etc...
 

Class Summary
BaseInfo Parent class for all Info objects.
BusinessLogicInfo Class Name: BusinessLogicInfo
Class Type:
Normal
Base Class:
None
Intf Class:
None
Description:
An info object that is passed to custom BusinessLogic classes during an execute action which is invoked at runtime.
GlobalVariable A HATS Global Variable is an object which can be the target of SetAction, ExtractAction, etc...
HCustomProperty Class defining an individual user-customizable property for an object implementing ICustomPropertySupplier.
HostScreen This is the HATS implementation of an ECLPS.
HostScreenField This is the HATS implementation of an ECLField.
HostScreenFieldList This is the HATS implementation of an ECLFieldList.
TextReplacementList A list of TextReplacementPairs.
TextReplacementPair An individual mapping between a string that is found in a host screen and the desired replacement text for that string.
TransformInfo This is a container object that is passed to a JSP inside the HttpServletRequest so that the tags may retrieve current status and host data information.

Example 1:
TransformInfo tInfo=((TransformInfo)request.getAttribute(CommonConstants.REQ_TRANSFORMINFO));
HostScreen hScreen= tInfo.getHostScreen();
int position = 1;
int length = hScreen.getSizeCols();
String firstRow = hScreen.getString(1,length);

Example 2:
((TransformInfo)request.getAttribute(CommonConstants.REQ_TRANSFORMINFO)).getSharedGlobalVariable("mySharedGV", true).getString();

For more information please refer to the BaseInfo Java documentation.
 


HATS 7.5.1 (201005110649)