com.sssw.atg.persist
Class AgoPersistentStoreManager

java.lang.Object
 |
 +--com.sssw.atg.persist.AgoPersistentStoreManager

public abstract class AgoPersistentStoreManager

extends Object

Abstract class that serves as a base class from which to subclass specific persistent store implementations. The persistent store should be implemented as an invoked business object and should always extend this class.

Constructor Summary

AgoPersistentStoreManager()

Method Summary

abstract Hashtable	initializeState(AgoInvokedEvent evt, String userID, String appID) Initializes the persistent store.
void	invoked(AgoInvokedEvent evt) An implementation of the invoked event for an AgoPersistentStoreManager object.
abstract Hashtable	loadState(AgoInvokedEvent evt, String userID, String appID) Reads the last persisted application state from the persistent store and returns it as a Hashtable.
abstract void	writeState(AgoInvokedEvent evt, String userID, String appID, Hashtable state) Writes the current application state to the persistent store.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AgoPersistentStoreManager

public AgoPersistentStoreManager()

Method Detail

invoked

public void invoked(AgoInvokedEvent evt)
             throws Exception

An implementation of the invoked event for an AgoPersistentStoreManager object. The invoked method of the subclassed AgoPersistentStoreManager should always call this method in the superclass.

Parameters:

evt - The event object passed into an invoked event of an InvokedListener business object.

loadState

public abstract Hashtable loadState(AgoInvokedEvent evt,
                                    String userID,
                                    String appID)
                             throws Exception

Reads the last persisted application state from the persistent store and returns it as a Hashtable. This is an abstract method that must be implemented in the subclass of the AgoPersistentStoreManager object.

Parameters:

evt - The event object passed into an invoked event of an InvokedListener business object.

userID - A String representing the persistent session ID for the current user. This value will be provided by the AgoPersistentStateManager at runtime.

appID - A String representing the application for which you would like to load the state. This String must match an application ID that has been defined in the PersistentSession.props file.

writeState

public abstract void writeState(AgoInvokedEvent evt,
                                String userID,
                                String appID,
                                Hashtable state)
                         throws Exception

Writes the current application state to the persistent store. This is an abstract method that must be implemented in the subclass of the AgoPersistentStoreManager object.

Parameters:

evt - The event object passed into an invoked event of an InvokedListener business object.

userID - A String representing the persistent session ID for the current user. This value will be provided by the AgoPersistentStateManager at runtime.

appID - A String representing the application for which you would like to load the state. This String must match an application ID that has been defined in the PersistentSession.props file.

state - A Hashtable representing the current state of the application

initializeState

public abstract Hashtable initializeState(AgoInvokedEvent evt,
                                          String userID,
                                          String appID)
                                   throws Exception

Initializes the persistent store. This is an abstract method that must be implemented in the subclass of the AgoPersistentStoreManager object.

Parameters:

evt - The event object passed into an invoked event of an InvokedListener business object.

userID - A String representing the persistent session ID for the current user. This value will be provided by the AgoPersistentStateManager at runtime.

appID - A String representing the application for which you would like to load the state. This String must match an application ID that has been defined in the PersistentSession.props file.