|
Oracle Fusion Middleware Java API Reference for Oracle ADF Controller 11g Release 1 (11.1.1.4.0) E10651-05 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SavePointManager
Defines an interface for creating, listing, retrieving and removing the save points. An instance of the SavePointManager can be obtained as follow:
SavePointManager mgr = ControllerContext.getInstance().getSavePointManager();The listSavePointIds() method will return an list of id strings of the existing save points for current user's security context. The attributes of a save point or the save point itself can be obtained by methods getSavePointAttributes() and getSavePoint() using the save point id.
Method Summary | |
---|---|
void |
cleanup()
Cleanup resources used by the save point manager. |
void |
clearSavePoints()
Removes all save points for the current user. |
java.lang.String |
createSavePoint()
Creates a save point with no custom attributes. |
java.lang.String |
createSavePoint(SavePointAttributes attrs)
Creates a save point for the current root view port and stores it. |
java.lang.String |
createSavePoint(SavePointAttributes attrs,
boolean removeOnComplete)
Deprecated. use createSavePoint() or createSavePoint(SavePointAttributes) |
SavePoint |
getSavePoint(java.lang.String id)
Gets the save point by id. |
SavePointAttributes |
getSavePointAttributes(java.lang.String id)
Gets the attributes of a save point by id. |
java.util.List<java.lang.String> |
listSavePointIds()
Returns an iterator of id strings for the save points that can be found in the state manager for the current user. |
SavePoint |
removeSavePoint(java.lang.String id)
Removes the save point with a given id. |
void |
setSavePointTimeToLive(long timeInSeconds)
Set the time to live period for all the created save points. |
Method Detail |
---|
java.lang.String createSavePoint()
@Deprecated java.lang.String createSavePoint(SavePointAttributes attrs, boolean removeOnComplete)
createSavePoint()
or createSavePoint(SavePointAttributes)
attrs
- attributes used to describe a save point, or nullremoveOnComplete
- if true, the save point will be automatically removed when
the top level bounded task flow on the stack completes.
If there is no bounded task flow on top of the stack,
removeOnComplete has no effect.
The false value is currently deprecated. So all
save points are assumed to be removable on complete,
regardless of the value of this argument.
java.lang.String createSavePoint(SavePointAttributes attrs)
attrs
- attributes used to describe a save point, or null
void setSavePointTimeToLive(long timeInSeconds)
SavePointManager
, if
the implementation allows it.
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.SavePoint getSavePoint(java.lang.String id)
id
- the id of the save point.
SavePointAttributes getSavePointAttributes(java.lang.String id)
id
- the id of the save point.
SavePoint removeSavePoint(java.lang.String id)
id
- the id of the save point.
void clearSavePoints()
java.util.List<java.lang.String> listSavePointIds()
void cleanup()
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Controller 11g Release 1 (11.1.1.4.0) E10651-05 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |