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
Class BaseInfo

java.lang.Object
  extended by com.ibm.hats.common.BaseInfo
All Implemented Interfaces:
IBaseInfo
Direct Known Subclasses:
TransformInfo

public class BaseInfo
extends Object
implements IBaseInfo

Parent class for all Info objects. BaseInfo provides common functionality for accessing locales, text replacement, global variables, screen orientation, the host screen, session IDs, and rendering properties.


Field Summary
 
Fields inherited from interface com.ibm.hats.common.IBaseInfo
CLASSNAME
 
Method Summary
protected  void calcClientLocale(IRequest req)
          Uses the class properties of this object to figure out which Locale is desired for use in client rendering.
 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.
 String getGlobalVariableValueForField(String name, boolean isOppositeToScreen)
          Gets the named global variable that supposed to be shown in Visual input field, optionally creating it if it doesn't already exist.
 HostScreen getHostScreen()
          Gets the current host screen.
 boolean getIsRtlCustomisation()
          Returns the customization screen orientation.
 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()
          Gets whether or not there is a screen reverse button.
 boolean isNewWindows()
          This method could be called while in HATS studio or in HATS runtime
 void setArabicOrientation(String Orientation)
          Sets the Arabic Shaping orientation.
 void setAutoFldRev(String autoFldRev)
           
 void setClassProperties(Hashtable render)
          Sets the rendering properties hashtable.
 void setClientLocale(Locale l)
          Sets the Locale to be used for rendering client displays.
 void setDefaultRendering(Hashtable defaultRendering)
          Sets the default rendering properties hashtable.
 void setGlobalVariables(Hashtable globalVar)
          Sets the hashtable of global variables.
 void setHostScreen(HostScreen presentation)
          Sets the current host screen.
 void setIsRtlCustomisation(boolean isRtlCustomisation)
          Sets the customization screen orientation.
 void setScreenOrientation(String screenOrientation)
          Sets the screen's orientation.
 void setScrRevButton(boolean hasScrRevButton)
          Sets whether or not there is a screen reverse button.
 void setSessionNumber(String sessionNum)
          Sets the session number for this session.
 void setSharedGlobalVariables(Hashtable globalVar)
          Sets the hashtable of global variables.
 void setTextReplacement(TextReplacementList textReplace)
          Sets the list of text replacements.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

calcClientLocale

protected void calcClientLocale(IRequest req)
Uses the class properties of this object to figure out which Locale is desired for use in client rendering. Subclasses may override.


getClientLocale

public final 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.

Specified by:
getClientLocale in interface IBaseInfo
Returns:
The Locale used for rendering client displays.

setClientLocale

public final void setClientLocale(Locale l)
Sets the Locale to be used for rendering client displays. For use in construction. Not for use by Business Logic code.


setTextReplacement

public final void setTextReplacement(TextReplacementList textReplace)
Sets the list of text replacements. For use in construction. Not for use by Business Logic code.


getTextReplacement

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

Specified by:
getTextReplacement in interface IBaseInfo
Returns:
The Hashtable of shared global variables.

setGlobalVariables

public final void setGlobalVariables(Hashtable globalVar)
Sets the hashtable of global variables. For use in construction. Not for use by Business Logic code.


getGlobalVariables

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

Specified by:
getGlobalVariables in interface IBaseInfo
Returns:
The Hashtable of global variables.

getGlobalVariable

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

Specified by:
getGlobalVariable in interface IBaseInfo
Parameters:
name - The name of the global variable to be retrieved.
Returns:
The specified global variable.

getGlobalVariable

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

Specified by:
getGlobalVariable in interface IBaseInfo
Parameters:
createIfNotExist - whether or not it should create a non-existent global variable
name - The name of the global variable to be retrieved.
Returns:
The specified global variable.

getGlobalVariableValueForField

public String getGlobalVariableValueForField(String name,
                                             boolean isOppositeToScreen)
Gets the named global variable that supposed to be shown in Visual input field, optionally creating it if it doesn't already exist.

Parameters:
isOppositeToScreen - whether input field will be oriented opposite to screen

getGlobalVariable

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

Specified by:
getGlobalVariable in interface IBaseInfo
Parameters:
createIfNotExist - whether or not it should create a non-existent global variable
bidiImplicit - if (bidiImplicit = true) display Implicit, if (bidiImplicit = false) display Visual.
name - The name of the global variable to be retrieved.
Returns:
The specified global variable.

setSharedGlobalVariables

public final void setSharedGlobalVariables(Hashtable globalVar)
Sets the hashtable of global variables. For use in construction. Not for use by Business Logic code.


getSharedGlobalVariables

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

Specified by:
getSharedGlobalVariables in interface IBaseInfo
Returns:
The Hashtable of shared global variables.

getSharedGlobalVariable

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

Specified by:
getSharedGlobalVariable in interface IBaseInfo
Parameters:
name - The name of the shared global variable to be retrieved.
Returns:
The specified shared global variable.

getSharedGlobalVariable

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

Specified by:
getSharedGlobalVariable in interface IBaseInfo
Parameters:
createIfNotExist - whether or not it should create a non-existent global variable
name - The name of the shared global variable to be retrieved.
Returns:
The specified shared global variable.

getSharedGlobalVariable

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

Specified by:
getSharedGlobalVariable in interface IBaseInfo
Parameters:
createIfNotExist - whether or not it should create a non-existent global variable
bidiImplicit - if (bidiImplicit = true) display Implicit if (bidiImplicit = false) display Visual.
name - The name of the shared global variable to be retrieved.
Returns:
The specified shared global variable.

getIsRtlCustomisation

public boolean getIsRtlCustomisation()
Returns the customization screen orientation.


setIsRtlCustomisation

public void setIsRtlCustomisation(boolean isRtlCustomisation)
Sets the customization screen orientation.


setScreenOrientation

public final void setScreenOrientation(String screenOrientation)
Sets the screen's orientation.


getScreenOrientation

public final String getScreenOrientation()
Returns the screen's orientation.

Specified by:
getScreenOrientation in interface IBaseInfo
Returns:
The screen's orientation.

setArabicOrientation

public final void setArabicOrientation(String Orientation)
Sets the Arabic Shaping orientation.


getArabicOrientation

public final String getArabicOrientation()
Gets the Arabic Shaping orientation.

Specified by:
getArabicOrientation in interface IBaseInfo
Returns:
The Arabic Shaping orientation.

setAutoFldRev

public final void setAutoFldRev(String autoFldRev)

getAutoFldRev

public final String getAutoFldRev()
Description copied from interface: IBaseInfo
Gets the auto field reverse.

Specified by:
getAutoFldRev in interface IBaseInfo
Returns:
The auto field reverse.

hasScrRevButton

public final boolean hasScrRevButton()
Gets whether or not there is a screen reverse button.

Specified by:
hasScrRevButton in interface IBaseInfo
Returns:
Returns true if the screen reverse button is present, false otherwise.

setScrRevButton

public final void setScrRevButton(boolean hasScrRevButton)
Sets whether or not there is a screen reverse button.


setSessionNumber

public final void setSessionNumber(String sessionNum)
Sets the session number for this session. For use in construction. Not for use by Business Logic code.


getSessionNumber

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

Specified by:
getSessionNumber in interface IBaseInfo
Returns:
The session number for this session.

setHostScreen

public final void setHostScreen(HostScreen presentation)
Sets the current host screen. For use in construction. Not for use by Business Logic code.


getHostScreen

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

Specified by:
getHostScreen in interface IBaseInfo
Returns:
The current host screen.

setClassProperties

public final void setClassProperties(Hashtable render)
Sets the rendering properties hashtable. For use in construction. Not for use by Business Logic code.


getClassProperties

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

Specified by:
getClassProperties in interface IBaseInfo
Returns:
The rendering properties Hashtable.

setDefaultRendering

public final void setDefaultRendering(Hashtable defaultRendering)
Sets the default rendering properties hashtable. For use in construction. Not for use by Business Logic code.


getDefaultRendering

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

Specified by:
getDefaultRendering in interface IBaseInfo
Returns:
The default rendering properties Hashtable.

isNewWindows

public boolean isNewWindows()
This method could be called while in HATS studio or in HATS runtime

Returns:
boolean - Returns true if in Windows Vista or Windows Server 2008

HATS 7.5.1 (201005110649)