|
HATS 7.5.1 Web API ReferencePublicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product. |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface IBusinessLogicInformation
Class Name: IBusinessLogicInformation The interface for an information object that is passed to custom BusinessLogic classes
during an execute action which is invoked at runtime.
Class Type: Interface
Base Class: IBaseInfo
Intf Class: None
Description:
Most of the methods belonging to this class return new generic interface objects which are wrapper objects for either Web or RCP
implementations for their corresponding namesakes. For example, the IConfig class is an interface wrapper class
for either an RcpConfig object or a WebConfig object. Likewise, IRequest is an interface
wrapper for either a RcpRequest object or a WebRequest object and IContext is an interface
wrapper for either a RcpContext object or a WebContext object. The IResponse class is
only an interface wrapper object for a WebResponse object since a corresponding Rich Client Platform response
object doesn't exist.
Additionally, WebRequest, WebResponse, WebConfig and WebContext are all wrapper classes for
HttpServletRequest, HttpServletResponse, ServletConfig and ServletContext respectively.
If a conversion from the interface object is required, it can be accomplished by implementing any of the following for a Web environment:
For an IRequest object,
a WebRequest object can be obtained by:
WebRequest webReq = (WebRequest)aIBusinessLogicInformation.getRequest();
and an HttpServletRequest object can further be obtained by:
HttpServletRequest httpReq = webReq.getHttpServletRequest();
For an IResponse object,
a WebResponse object can be obtained by:
WebResponse webRes = (WebResponse)aIBusinessLogicInformation.getResponse();
and an HttpServletResponse object can further be obtained by:
HttpServletResponse httpRes = webRes.getHttpServletResponse();
For an IConfig object,
a WebConfig object can be obtained by:
WebConfig webCfg = (WebConfig)aIBusinessLogicInformation.getConfig();
and an ServletConfig object can further be obtained by:
ServletConfig servCfg = webCfg.getServletConfig();
For an IContext object,
a WebContext object can be obtained by:
WebContext webCtx = (WebContext)aIBusinessLogicInformation.getContext();
and an ServletContext object can further be obtained by:
ServletContext servCtx = webCtx.getServletContext();
This same rationale can be used to obtain an RcpRequest, RcpConfig or RcpContext object in a Rich
Client Platform environment.
IRequest,
WebRequest,
IResponse,
WebResponse,
IConfig,
WebConfig,
IContext,
WebContext| Field Summary | |
|---|---|
static String |
CLASSNAME
The fully-qualified name of this class. |
| Method Summary | |
|---|---|
Map |
getCombinedScreens()
Returns the Map of the combined screens. |
IConfig |
getConfig()
Returns the current IConfig object for this connection. |
Map |
getConnectionMap()
Returns the connection Map for this connection. |
IContext |
getContext()
Returns the current IContext object for this connection. |
IRequest |
getRequest()
Returns the IRequest object for this connection. |
IResponse |
getResponse()
Returns the current IResponse object for this connection. |
| Methods inherited from interface com.ibm.hats.common.IBaseInfo |
|---|
getArabicOrientation, getAutoFldRev, getClassProperties, getClientLocale, getDefaultRendering, getGlobalVariable, getGlobalVariable, getGlobalVariable, getGlobalVariables, getHostScreen, getScreenOrientation, getSessionNumber, getSharedGlobalVariable, getSharedGlobalVariable, getSharedGlobalVariable, getSharedGlobalVariables, getTextReplacement, hasScrRevButton |
| Field Detail |
|---|
static final String CLASSNAME
| Method Detail |
|---|
Map getCombinedScreens()
IConfig getConfig()
Map getConnectionMap()
This is a Map of several internal-use-only objects. The one documented object is the transformation connection's
HOD Session instance. Refer to com.ibm.eNetwork.beans.HOD.Session for
more information on this object. The key for the object is the String
com.ibm.hats.runtime.RuntimeConstants.CLASSNAME_SESSION. Business logic should take care not to alter the
returned Map.
IContext getContext()
IRequest getRequest()
IResponse getResponse()
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||