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
Interface IBaseInfo

All Known Subinterfaces:
IBusinessLogicInformation
All Known Implementing Classes:
BaseInfo, TransformInfo

public interface IBaseInfo

Class Name: IBaseInfo
Class Type:
Interface
Base Class:
None
Intf Class:
None
Description:
The interface parent class for all information objects. IBaseInfo provides common functionality for accessing locales, text replacement, global variables, screen orientation, the host screen, session IDs, and rendering properties.


Field Summary
static String CLASSNAME
          The fully-qualified name of this class.
 
Method Summary
 String getArabicOrientation()
          Gets the Arabic Shaping orientation.
 String getAutoFldRev()
          Gets the auto field reverse.
 Hashtable getClassProperties()
          Gets the rendering properties Hashtable.
 Locale getClientLocale()
          Returns the Locale to be used for rendering client displays (browser button labels, for example).
 Hashtable getDefaultRendering()
          Gets the default rendering properties Hashtable.
 IGlobalVariable getGlobalVariable(String name)
          Gets the named global variable.
 IGlobalVariable getGlobalVariable(String name, boolean createIfNotExist)
          Gets the named global variable, optionally creating it if it doesn't already exist.
 IGlobalVariable getGlobalVariable(String name, boolean createIfNotExist, boolean bidiImplicit)
          Gets the named global variable, optionally creating it if it doesn't already exist.
 Hashtable getGlobalVariables()
          Returns the Hashtable of global variables.
 HostScreen getHostScreen()
          Gets the current host screen.
 String getScreenOrientation()
          Returns the screen's orientation.
 String getSessionNumber()
          Returns the session number for this session.
 IGlobalVariable getSharedGlobalVariable(String name)
          Gets the named shared global variable.
 IGlobalVariable getSharedGlobalVariable(String name, boolean createIfNotExist)
          Gets the named shared global variable, optionally creating it if it doesn't already exist.
 IGlobalVariable getSharedGlobalVariable(String name, boolean createIfNotExist, boolean bidiImplicit)
          Gets the named shared global variable, optionally creating it if it doesn't already exist.
 Hashtable getSharedGlobalVariables()
          Gets the Hashtable of shared global variables.
 TextReplacementList getTextReplacement()
          Returns the list of text replacements.
 boolean hasScrRevButton()
          Retrieves the presence status of the screen reverse button.
 

Field Detail

CLASSNAME

static final String CLASSNAME
The fully-qualified name of this class. This is used for controlling and displaying traces.

Method Detail

getArabicOrientation

String getArabicOrientation()
Gets the Arabic Shaping orientation.

Returns:
The Arabic Shaping orientation.

getAutoFldRev

String getAutoFldRev()
Gets the auto field reverse.

Returns:
The auto field reverse.

getClassProperties

Hashtable getClassProperties()
Gets the rendering properties Hashtable. Note that altering the returned object may have unintended effects.

Returns:
The rendering properties Hashtable.

getClientLocale

Locale getClientLocale()
Returns the Locale to be used for rendering client displays (browser button labels, for example). This Locale is not necessarily one of the product's fully supported Locales.

Returns:
The Locale used for rendering client displays.

getDefaultRendering

Hashtable getDefaultRendering()
Gets the default rendering properties Hashtable. Note that altering the returned object may have unintended effects.

Returns:
The default rendering properties Hashtable.

getGlobalVariable

IGlobalVariable getGlobalVariable(String name)
Gets the named global variable.

Parameters:
name - The name of the global variable to be retrieved.
Returns:
The specified global variable.

getGlobalVariable

IGlobalVariable getGlobalVariable(String name,
                                  boolean createIfNotExist)
Gets the named global variable, optionally creating it if it doesn't already exist.

Parameters:
name - The name of the global variable to be retrieved.
createIfNotExist - Specifies if it should create a non-existent global variable.
Returns:
The specified global variable.

getGlobalVariable

IGlobalVariable getGlobalVariable(String name,
                                  boolean createIfNotExist,
                                  boolean bidiImplicit)
Gets the named global variable, optionally creating it if it doesn't already exist.

Parameters:
name - The name of the global variable to be retrieved.
createIfNotExist - Specifies if it should create a non-existent global variable.
bidiImplicit - If (bidiImplicit = true) display Implicit, if (bidiImplicit = false) display Visual.
Returns:
The specified global variable.

getGlobalVariables

Hashtable getGlobalVariables()
Returns the Hashtable of global variables. Note that altering the returned object may have unintended effects.

Returns:
The Hashtable of global variables.

getHostScreen

HostScreen getHostScreen()
Gets the current host screen. Note that altering the returned object may have unintended effects.

Returns:
The current host screen.

getScreenOrientation

String getScreenOrientation()
Returns the screen's orientation.

Returns:
The screen's orientation.

getSessionNumber

String getSessionNumber()
Returns the session number for this session.

Returns:
The session number for this session.

getSharedGlobalVariable

IGlobalVariable getSharedGlobalVariable(String name)
Gets the named shared global variable.

Parameters:
name - The name of the shared global variable to be retrieved.
Returns:
The specified shared global variable.

getSharedGlobalVariable

IGlobalVariable getSharedGlobalVariable(String name,
                                        boolean createIfNotExist)
Gets the named shared global variable, optionally creating it if it doesn't already exist.

Parameters:
name - The name of the shared global variable to be retrieved.
createIfNotExist - Specifies if it should create a non-existent shared global variable.
Returns:
The specified shared global variable.

getSharedGlobalVariable

IGlobalVariable getSharedGlobalVariable(String name,
                                        boolean createIfNotExist,
                                        boolean bidiImplicit)
Gets the named shared global variable, optionally creating it if it doesn't already exist.

Parameters:
name - The name of the shared global variable to be retrieved.
createIfNotExist - Specifies if it should create a non-existent shared global variable.
bidiImplicit - If (bidiImplicit = true) display Implicit, if (bidiImplicit = false) display Visual.
Returns:
The specified shared global variable.

getSharedGlobalVariables

Hashtable getSharedGlobalVariables()
Gets the Hashtable of shared global variables. Note that altering the returned object may have unintended effects.

Returns:
The Hashtable of shared global variables.

getTextReplacement

TextReplacementList getTextReplacement()
Returns the list of text replacements. Note that altering the returned object may have unintended effects.

Returns:
The Hashtable of shared global variables.

hasScrRevButton

boolean hasScrRevButton()
Retrieves the presence status of the screen reverse button.

Returns:
Returns true if the screen reverse button is present, false otherwise.

HATS 7.5.1 (201005110649)