oracle.dss.thin.beans
Interface CheckpointState

All Known Subinterfaces:

ThinDataviewCommon

All Known Implementing Classes:

Query, BaseThinBeanUI

public interface CheckpointState

Methods for checkpointing state. Use the methods in this interface, in conjunction with the state management methods in the ThinBean interface, when you save thin-bean state in State objects in the BI Beans Catalog.

The following methods initialize state management and retrieve state changes:

• ThinBean.setBaseState clears the state string and initializes state management in the thin bean. Call setBaseState whenever you instantiate a thin bean and whenever you load a thin bean from the BI Beans Catalog.
• ThinBean.getState retrieves state changes since the call to setBaseState. You can store the state string in the URL or in an oracle.cabo.servlet.state.MutableState. If the URL grows large enough that it might overflow the browser limit of the URL size, then save the state string in the MutableState and save the MutableState to the BI Beans Catalog, through the BIStateManager.
• checkpointState clears the checkpoint state and initializes checkpointing. In checkpointing, the thin bean keeps track of state changes since the call to checkpointState.
• getCheckpointState retrieves state changes since the last call to checkpointState. You can store this string in the URL or in a MutableState.

The following methods set state on a thin bean.

• Call ThinBean.setState to set the state that came from a call to getState. This sets state changes that occur between the call to setBaseState and the call to getState.
• If you use checkpointing, then call setCheckpointState to set the state that came from a call to getCheckpointState.

For more information about state management, see the BI Beans Help system.

See Also:

ThinBean.setBaseState(), ThinBean.getState(), ThinBean.setState(java.lang.String), BIStateManager

Method Summary

void	checkpointState() Initiates tracking of checkpoint state.
java.lang.String	getCheckpointState() Retrieves state differences since the last call to checkpointState.
void	setCheckpointState(java.lang.String state) Sets on this thin bean the state changes since the last call to checkpointState.

Method Detail

getCheckpointState

public java.lang.String getCheckpointState()

Retrieves state differences since the last call to checkpointState.

You normally store the returned String in the URL. The return value from this method, together with the return value from the getState method, describe all of the state changes that have been made to this thin bean since it was initialized (since the last call to setBaseState).

Returns:

Changes that have been made to the state of this thin bean since checkpointState was last called.

See Also:

checkpointState(), ThinBean.getState(), ThinBean.setBaseState()

setCheckpointState

public void setCheckpointState(java.lang.String state)
                        throws ThinException

Sets on this thin bean the state changes since the last call to checkpointState.

Parameters:

state - The state differences from the last call to checkpointState.

Throws:

ThinException - If the state could not be set.

See Also:

ThinBean.setState(java.lang.String)

checkpointState

public void checkpointState()

Initiates tracking of checkpoint state. Before you call this method, call the getState method of the thin bean. Save the state string that getState returns in an oracle.cabo.servlet.state.MutableState object. Save the MutableState to the BI Beans Catalog, by calling the saveState method of the BIStateManager. Then, call this method to keep track of changes that occur after you save the state string in the Catalog.

See Also:

ThinBean.getState(), BIStateManager