|
Oracle Fusion Middleware Java API Reference for Oracle ADF Controller 11g Release 2 (11.1.2.3.0) E17480-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ViewPortContext
Context class for all per request per web application per view port information. A view port displays markup produced by view activities and is capable of accepting user input. A browser window, a modal dialog and a region UI component are all examples of a view port.
Method Summary | |
---|---|
void |
clearException() Clear any exception held by the view port. |
java.lang.String |
createSavePoint() Deprecated. use SavePointManager.createSavePoint(SavePointAttributes, boolean) |
java.lang.String |
createSavePoint(java.lang.String id, SavePointAttributes attrs) Deprecated. use SavePointManager.createSavePoint(SavePointAttributes, boolean) Custom save point ids are no longer supported. |
java.util.Map<java.lang.String,java.lang.String> |
getDiagInfo() Get diagnostic information about the view port. |
java.lang.Exception |
getExceptionData() Returns the most recent Exception that has occurred within the view port. |
TaskFlowContext |
getTaskFlowContext() Returns the TaskFlowContext for the task flow on top of the stack corresponding to this view port. |
java.lang.String |
getViewId() Returns the View Id corresponding to the current view activity. |
boolean |
isDataDirty() Returns true if this view port, or any of its children view ports, has a current task flow with uncommitted ADF model data. |
boolean |
isEmpty() Returns true, if this view port is not executing any task flows. |
boolean |
isExceptionPresent() Returns true, if a RuntimeException has been thrown during task flow processing. |
boolean |
isViewBookmarkable() Returns true, if the current view activity is considered bookmarkable. |
void |
setSavePointTimeToLive(long timeInSeconds) Deprecated. use SavePointManager.setSavePointTimeToLive(long) |
void |
setViewId(java.lang.String id) Set the view activity to be displayed in the view port. |
Method Detail |
---|
@Deprecated
java.lang.String createSavePoint(java.lang.String id,
SavePointAttributes attrs)
SavePointManager.createSavePoint(SavePointAttributes, boolean)
Custom save point ids are no longer supported.SavePointManager
. The save point will contain:
id
- The save point Id, or null if the Id is to be generated.attrs
- Attributes used to describe a save point.
@Deprecated
java.lang.String createSavePoint()
SavePointManager.createSavePoint(SavePointAttributes, boolean)
SavePointManager
to store the save point. The save point created in this way will not be removed when the top level bounded task flow completes. In other words, removeOnComplete is assumed to be false.
This API can be called from EL, the expression is: #{controllerContext.currentViewPort.createSavePoint}.
java.lang.String getViewId()
void setViewId(java.lang.String id)
Note: This method may only be called during the INVOKE_APPLICATION phase of the request lifecycle.
id
- ID of a view activity within the view port's current task flow.AdfcUnsupportedOperationException
- if called at any time other than the INVOKE_APPLICATION phase of the request lifecycle.AdfcIllegalArgumentException
- if the ID is not a valid view activity ID within the view port's current task flow.boolean isViewBookmarkable()
java.lang.Exception getExceptionData()
Exception
that has occurred within the view port. The exception exists on the view port until either another exception occurrs or until removed via the clearException()
method.void clearException()
TaskFlowContext getTaskFlowContext()
TaskFlowContext
for the task flow on top of the stack corresponding to this view port. If this view port is not currently executing a task flow, throws a RuntimeException.TaskFlowContext
boolean isEmpty()
boolean isExceptionPresent()
RuntimeException
has been thrown during task flow processing.
@Deprecated
void setSavePointTimeToLive(long timeInSeconds)
SavePointManager.setSavePointTimeToLive(long)
SavePoint
created for this view port. This is the time beyond which the save point will be removed by the SavePointManager
. The default time-to-live is 24 hours.timeInSeconds
- The time-to-live in seconds. If this value is equal or less than zero, then the default time-to-live will be used.boolean isDataDirty()
java.util.Map<java.lang.String,java.lang.String> getDiagInfo()
Note: a specific set of diagnistic values is not guarenteed to be in the result every time this method is called. The content of the diagnostic map may vary depending on the state of the view port and the internal implementation of the view port abstraction. Clients should not depend on a specific value being in the result set.
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Controller 11g Release 2 (11.1.2.3.0) E17480-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |