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 BusinessLogicInfo

java.lang.Object
  extended by com.ibm.hats.common.BusinessLogicInfo

public class BusinessLogicInfo
extends Object

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. This class is now a wrapper class that is deprecated and only supplied to maintian compatibility with previous versions.

Note that most of the setters in this object are not for use by customer-supplied business logic, but are used by internal code only.


Method Summary
 String getArabicOrientation()
          Deprecated.  
 String getAutoFldRev()
          Deprecated.  
 com.ibm.hats.common.BusinessLogicInformation getBusinessLogicInformation()
          Returns the new BusinessLogicInformation object which allows code to retrieve this object for the invocation of new methods.
 Hashtable getClassProperties()
          Deprecated.  
 Locale getClientLocale()
          Deprecated.  
 Hashtable getDefaultRendering()
          Deprecated.  
 IGlobalVariable getGlobalVariable(String name)
          Deprecated.  
 IGlobalVariable getGlobalVariable(String name, boolean createIfNotExist)
          Deprecated.  
 IGlobalVariable getGlobalVariable(String name, boolean createIfNotExist, boolean bidiImplicit)
          Deprecated.  
 Hashtable getGlobalVariables()
          Deprecated.  
 HostScreen getHostScreen()
          Deprecated.  
 javax.servlet.http.HttpServletRequest getRequest()
          Deprecated.  
 javax.servlet.http.HttpServletResponse getResponse()
          Deprecated.  
 String getScreenOrientation()
          Deprecated.  
 javax.servlet.ServletConfig getServletConfig()
          Deprecated.  
 javax.servlet.ServletContext getServletContext()
          Deprecated.  
 String getSessionNumber()
          Deprecated.  
 IGlobalVariable getSharedGlobalVariable(String name)
          Deprecated.  
 IGlobalVariable getSharedGlobalVariable(String name, boolean createIfNotExist)
          Deprecated.  
 IGlobalVariable getSharedGlobalVariable(String name, boolean createIfNotExist, boolean bidiImplicit)
          Deprecated.  
 Hashtable getSharedGlobalVariables()
          Deprecated.  
 TextReplacementList getTextReplacement()
          Deprecated.  
 boolean hasScrRevButton()
          Deprecated.  
 void setArabicOrientation(String orientation)
          Deprecated.  
 void setAutoFldRev(String autoFldRev)
          Deprecated.  
 void setClassProperties(Hashtable render)
          Deprecated.  
 void setClientLocale(Locale loc)
          Deprecated.  
 void setDefaultRendering(Hashtable defaultRendering)
          Deprecated.  
 void setGlobalVariables(Hashtable globalVar)
          Deprecated.  
 void setHostScreen(HostScreen presentation)
          Deprecated.  
 void setScreenOrientation(String screenOrientation)
          Deprecated.  
 void setScrRevButton(boolean hasScrRevButton)
          Deprecated.  
 void setSessionNumber(String sessionNum)
          Deprecated.  
 void setSharedGlobalVariables(Hashtable globalVar)
          Deprecated.  
 void setTextReplacement(TextReplacementList textReplace)
          Deprecated.  
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getBusinessLogicInformation

public final com.ibm.hats.common.BusinessLogicInformation getBusinessLogicInformation()
Returns the new BusinessLogicInformation object which allows code to retrieve this object for the invocation of new methods. This method is not available in the interface.

Returns:
Returns the businessLogicInformation.

getRequest

public javax.servlet.http.HttpServletRequest getRequest()
Deprecated. 

Returns the HttpServletRequest object for this connection.

Returns:
The HttpServletRequest.

getResponse

public javax.servlet.http.HttpServletResponse getResponse()
Deprecated. 

Returns the current HttpServletResponse object for this connection.

Returns:
The HttpServletResponse object.

getServletConfig

public javax.servlet.ServletConfig getServletConfig()
Deprecated. 

Returns the current ServletConfig object for this connection.

Returns:
The ServletConfig object.

getServletContext

public javax.servlet.ServletContext getServletContext()
Deprecated. 

Returns the current ServletContext object for this connection.

Returns:
The ServletContext object.

getClientLocale

public Locale getClientLocale()
Deprecated. 

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 client Locale.

setClientLocale

public void setClientLocale(Locale loc)
Deprecated. 

Sets the Locale to be used for rendering client displays. For use in construction. Not for use by Business Logic code.

Parameters:
loc - The client Locale.

setTextReplacement

public void setTextReplacement(TextReplacementList textReplace)
Deprecated. 

Sets the list of text replacements. For use in construction. Not for use by Business Logic code.

Parameters:
textReplace - This list of text replacements.

getTextReplacement

public TextReplacementList getTextReplacement()
Deprecated. 

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

Returns:
The list of text replacements.

setGlobalVariables

public void setGlobalVariables(Hashtable globalVar)
Deprecated. 

Sets the hashtable of global variables. For use in construction. Not for use by Business Logic code.

Parameters:
globalVar - The Hashtable of global variables.

getGlobalVariables

public Hashtable getGlobalVariables()
Deprecated. 

Returns the hashtable of global variables. Note that altering the returned object may have unintended effects.

Returns:
The Hashtable of global variables.

getGlobalVariable

public IGlobalVariable getGlobalVariable(String name)
Deprecated. 

Gets the named global variable.

Parameters:
name - The name of the global variable.
Returns:
The named global variable.

getGlobalVariable

public IGlobalVariable getGlobalVariable(String name,
                                         boolean createIfNotExist)
Deprecated. 

Gets the named global variable, optionally creating it if it doesn't already exist.

Parameters:
name - The name of the global variable.
createIfNotExist - Whether or not it should create a non-existent global variable
Returns:
The named global variable.

getGlobalVariable

public IGlobalVariable getGlobalVariable(String name,
                                         boolean createIfNotExist,
                                         boolean bidiImplicit)
Deprecated. 

Gets the named global variable, optionally creating it if it doesn't already exist.

Parameters:
name - The name of the global variable.
createIfNotExist - Whether or not it should create a non-existent global variable
bidiImplicit - If (bidiImplicit = true) display Implicit, if (bidiImplicit = false) display Visual.
Returns:
The named global variable.

setSharedGlobalVariables

public void setSharedGlobalVariables(Hashtable globalVar)
Deprecated. 

Sets the hashtable of global variables. For use in construction. Not for use by Business Logic code.

Parameters:
globalVar - The global variable Hashtable.

getSharedGlobalVariables

public Hashtable getSharedGlobalVariables()
Deprecated. 

Gets the hashtable of shared global variables. Note that altering the returned object may have unintended effects.

Returns:
The shared global variables.

getSharedGlobalVariable

public IGlobalVariable getSharedGlobalVariable(String name)
Deprecated. 

Gets the named shared global variable.

Parameters:
name - The name of the shared global variable.
Returns:
The named shared global variable.

getSharedGlobalVariable

public IGlobalVariable getSharedGlobalVariable(String name,
                                               boolean createIfNotExist)
Deprecated. 

Gets the named shared global variable, optionally creating it if it doesn't already exist.

Parameters:
name - The name of the shared global variable.
createIfNotExist - Whether or not it should create a non-existent global variable.
Returns:
The named shared global variable.

getSharedGlobalVariable

public IGlobalVariable getSharedGlobalVariable(String name,
                                               boolean createIfNotExist,
                                               boolean bidiImplicit)
Deprecated. 

Gets the named shared global variable, optionally creating it if it doesn't already exist.

Parameters:
name - The name of the shared global variable.
createIfNotExist - Whether or not it should create a non-existent global variable.
bidiImplicit - If (bidiImplicit = true) display Implicit if (bidiImplicit = false) display Visual.
Returns:
The named shared global variable.

setScreenOrientation

public void setScreenOrientation(String screenOrientation)
Deprecated. 

Sets the screen's orientation.

Parameters:
screenOrientation - The screen orientation.

getScreenOrientation

public String getScreenOrientation()
Deprecated. 

Returns the screen's orientation.

Returns:
The screen orientation.

setArabicOrientation

public void setArabicOrientation(String orientation)
Deprecated. 

Sets the Arabic Shaping orientation.

Parameters:
orientation - The Arabic Shaping orientation.

getArabicOrientation

public String getArabicOrientation()
Deprecated. 

Gets the Arabic Shaping orientation.

Returns:
The Arabic Shaping orientation.

setAutoFldRev

public void setAutoFldRev(String autoFldRev)
Deprecated. 

Set the auto field revision.

Parameters:
autoFldRev - The auto field revision.

getAutoFldRev

public String getAutoFldRev()
Deprecated. 

Retrieve the auto field revision.

Returns:
The auto field revision.

hasScrRevButton

public boolean hasScrRevButton()
Deprecated. 

Gets whether or not there is a screen reverse button.

Returns:
True if a screen reverse button is present, false otherwise.

setScrRevButton

public void setScrRevButton(boolean hasScrRevButton)
Deprecated. 

Sets whether or not there is a screen reverse button.

Parameters:
hasScrRevButton - Boolean input parameter specifying the presence of a screen reverse button.

setSessionNumber

public void setSessionNumber(String sessionNum)
Deprecated. 

Sets the session number for this session. For use in construction. Not for use by Business Logic code.

Parameters:
sessionNum - The session number.

getSessionNumber

public String getSessionNumber()
Deprecated. 

Returns the session number for this session.

Returns:
The session number for this session.

setHostScreen

public void setHostScreen(HostScreen presentation)
Deprecated. 

Sets the current host screen. For use in construction. Not for use by Business Logic code.

Parameters:
presentation - The current host screen.

getHostScreen

public HostScreen getHostScreen()
Deprecated. 

Gets the current host screen. Note that altering the returned object may have unintended effects.

Returns:
The current host screen.

setClassProperties

public void setClassProperties(Hashtable render)
Deprecated. 

Sets the rendering properties hashtable. For use in construction. Not for use by Business Logic code.

Parameters:
render - The rendering porperties Hashtable.

getClassProperties

public Hashtable getClassProperties()
Deprecated. 

Gets the rendering properties hashtable. Note that altering the returned object may have unintended effects.

Returns:
The rendering properties Hashtable.

setDefaultRendering

public void setDefaultRendering(Hashtable defaultRendering)
Deprecated. 

Sets the default rendering properties hashtable. For use in construction. Not for use by Business Logic code.

Parameters:
defaultRendering - The default rendering Hashtable.

getDefaultRendering

public Hashtable getDefaultRendering()
Deprecated. 

Gets the default rendering properties hashtable. Note that altering the returned object may have unintended effects.

Returns:
The default rendering properties Hashtable.

HATS 7.5.1 (201005110649)