PREV CLASS
NEXT CLASS
|
|
|
|
SUMMARY: NESTED | FIELD | CONSTR | METHOD |
DETAIL: FIELD | CONSTR | METHOD |
com.ibm.portal.state
Interface StateHolder
- All Superinterfaces:
- Disposable
- All Known Subinterfaces:
- StateHolderController
-
public interface StateHolder
- extends Disposable
Read-only interface to state. You can get access to the untyped document model or
create a URL object based upon this state.
Use the state manager to get typed accessors to this state.
- Since:
- 5.1
getModel
DocumentModel getModel()
- Accesses the (untyped) document model that this state represents.
- Returns:
- Read-only interface to the untyped document model.
newState
StateHolderController newState(Constants.Clone type)
throws InvalidConstantException,
CannotCloneDocumentModelException,
CannotCreateDocumentException
- Creates a new state object. Depending on the parameter type the state object
will be preinitialized with the current state or it will be emtpy. You may modify
the state in the engine URL object without affecting the state in the original state
holder. It is possible to get more than one engine URL object at a time.
- Parameters:
- type - Constant that decides about the initial state of the engine URL,
may be null in which case a SMART_COPY will be generated.
- Returns:
- New copy of the state holder
- Throws:
- InvalidConstantException - The constant could not be recognized
- CannotCloneDocumentModelException - State could not be copied during the creation process of the engine URL
- CannotCreateDocumentException - Unable to create empty state for the new URL object
PREV CLASS
NEXT CLASS
|
|
|
|
SUMMARY: NESTED | FIELD | CONSTR | METHOD |
DETAIL: FIELD | CONSTR | METHOD |