|
Oracle ADF Model and Business Components API Reference 10.1.2 B14022-01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.jbo.html.BC4JContext
BC4JContext define a set of method a BC4J Web application use to access attributes of the binding to the current BC4J model.
There is one BC4JContext
per request and it can be retrieve from the request using
the getContext
method.
For a BC4J Web application using Struts, the BC4JContext
is initialized
by the BC4JRequestProcessor
and
the BC4JActionMapping
classes.
Field Summary | |
static java.lang.String |
ContextAttrName
The request attributes key under which our BC4JContext instance
will be stored. |
Constructor Summary | |
BC4JContext()
|
Method Summary | |
ApplicationModule |
getApplicationModule()
Returns an application module instance from the sessionCookie |
static BC4JContext |
getContext(javax.servlet.http.HttpServletRequest request)
Return our BC4JContext given a HttpServletRequest |
static BC4JContext |
getContext(javax.servlet.ServletRequest request)
Return our BC4JContext given a ServletRequest |
java.lang.String |
getCurrentPath()
Return the current servlet path. |
java.lang.String |
getEvent()
Returns the event property. |
java.lang.String |
getPreviousPath()
Return the previous servlet path. |
java.lang.String |
getProperty(java.lang.String key)
Used to retrieve custom properties from the BC4JContext |
Row |
getRow()
Retrieve the row property value If the row has not been set explicitly, this method use the rowkey information from this BC4JContext to retrieve the row. |
java.lang.String |
getRowkey()
Return the rowkey property. |
SessionCookie |
getSessionCookie()
Return the sessionCookie property. |
ViewObject |
getViewObject()
Returns the viewObject property. |
void |
initialize(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Initialize the content the of the context using a request and response object. |
void |
setCurrentPath(java.lang.String value)
Set the current servlet path. |
void |
setEvent(java.lang.String event)
Set the event property value. |
void |
setPreviousPath(java.lang.String value)
Set the previous servlet path. |
void |
setProperty(java.lang.String key,
java.lang.String value)
Used to store custom properties in the BC4JContext |
void |
setRow(Row row)
Set the row property value |
void |
setRowkey(java.lang.String rowkey)
Set the rowkey property value. |
void |
setSessionCookie(SessionCookie cookie)
Set the sessionCookie property value. |
void |
setViewObject(ViewObject vo)
Set the viewObject property value. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String ContextAttrName
BC4JContext
instance
will be stored.
getContext(ServletRequest request)
,
getContext(HttpServletRequest request)
,
Constant Field ValuesConstructor Detail |
public BC4JContext()
Method Detail |
public void initialize(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
BC4JContext
given their values.
JBOEVENT
("jboEvent") parameter key.findViewObject
method
using the JBOEVENTVO
("jboEventVO") parameter key.ROWKEY_PARAM
("jboRowKey") parameter key.
public static final BC4JContext getContext(javax.servlet.ServletRequest request)
BC4JContext
given a ServletRequest
request
- the current requestContextAttrName
public static final BC4JContext getContext(javax.servlet.http.HttpServletRequest request)
BC4JContext
given a HttpServletRequest
request
- the current requestContextAttrName
public ApplicationModule getApplicationModule()
oracle.jbo.common.ampool.ApplicationModuleRef.useApplicationModule()
public void setViewObject(ViewObject vo)
initialize
method.
public ViewObject getViewObject()
public void setEvent(java.lang.String event)
initialize
method.
public java.lang.String getEvent()
public void setRowkey(java.lang.String rowkey)
initialize
method.
public java.lang.String getRowkey()
public SessionCookie getSessionCookie()
public void setSessionCookie(SessionCookie cookie)
initialize
method.
public void setPreviousPath(java.lang.String value)
public java.lang.String getPreviousPath()
public void setCurrentPath(java.lang.String value)
public java.lang.String getCurrentPath()
HttpServletRequest.getServletPath()
public void setProperty(java.lang.String key, java.lang.String value)
BC4JContext
public java.lang.String getProperty(java.lang.String key)
BC4JContext
public void setRow(Row row)
public Row getRow()
BC4JContext
to retrieve the row.
oracle.jbo.client.JboUtil#getRowFromKey(RowSet, String)
|
Oracle ADF Model and Business Components API Reference 10.1.2 B14022-01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 1997, 2004, Oracle. All rights reserved.