Package org.gatein.pc.portlet.state.producer

Interface PortletStatePersistenceManager

All Known Implementing Classes:

AbstractPortletStatePersistenceManager, PortletStatePersistenceManagerService

public interface PortletStatePersistenceManager

An abstraction for enabling state management on the producer side.

Method Summary

Modifier and Type	Method	Description
String	cloneState(String stateId)	Clone an existing state.
String	cloneState(String stateId, org.gatein.pc.api.state.PropertyMap propertyMap)	Clone an existing state.
String	createState(String portletId, org.gatein.pc.api.state.PropertyMap propertyMap)	Create the initial state.
void	destroyState(String stateId)	Destroy the state.
PortletStateContext	loadState(String stateId)	Load the state.
void	updateState(String stateId, org.gatein.pc.api.state.PropertyMap propertyMap)	Update the state.

Method Details

loadState

PortletStateContext loadState(String stateId)
                       throws IllegalArgumentException,
NoSuchStateException,
InvalidStateIdException

Load the state.

Parameters:

stateId - the state id

Returns:

the value map or null if it does not exist

Throws:

IllegalArgumentException - if the state id is null

NoSuchStateException - is the specified state does not exist

InvalidStateIdException - if the state id is not valid

createState

String createState(String portletId,
 org.gatein.pc.api.state.PropertyMap propertyMap)
            throws IllegalArgumentException

Create the initial state.

Parameters:

portletId - the id that this state refers to

Returns:

the id of the state created

Throws:

IllegalArgumentException - if the portlet id is null

cloneState

String cloneState(String stateId)
           throws IllegalArgumentException,
NoSuchStateException,
InvalidStateIdException

Clone an existing state.

Parameters:

stateId - the id that this state refers to

Returns:

the state id

Throws:

IllegalArgumentException - if the state id is null

NoSuchStateException - is the specified state does not exist

InvalidStateIdException - if the state id is not valid

cloneState

String cloneState(String stateId,
 org.gatein.pc.api.state.PropertyMap propertyMap)
           throws IllegalArgumentException,
NoSuchStateException,
InvalidStateIdException

Clone an existing state.

Parameters:

stateId - the id that this state refers to

propertyMap - the values of the cloned state

Returns:

the state id

Throws:

IllegalArgumentException - if the state id is null or the value is nul

NoSuchStateException - is the specified state does not exist

InvalidStateIdException - if the state id is not valid

updateState

void updateState(String stateId,
 org.gatein.pc.api.state.PropertyMap propertyMap)
          throws IllegalArgumentException,
NoSuchStateException,
InvalidStateIdException

Update the state.

Parameters:

stateId -

propertyMap - the updated state

Throws:

IllegalArgumentException - if the state id is null or the values are null

NoSuchStateException - is the specified state does not exist

InvalidStateIdException - if the state id is not valid

destroyState

void destroyState(String stateId)
           throws IllegalArgumentException,
NoSuchStateException,
InvalidStateIdException

Destroy the state.

Parameters:

stateId -

Throws:

IllegalArgumentException - if the state id is null

NoSuchStateException - is the specified state does not exist

InvalidStateIdException - if the state id is not valid