Package org.gatein.pc.portlet.state

Class AbstractPropertyContext

java.lang.Object

org.gatein.pc.portlet.state.AbstractPropertyContext

All Implemented Interfaces:

org.gatein.pc.api.state.PropertyContext

public class AbstractPropertyContext
extends Object
implements org.gatein.pc.api.state.PropertyContext

Version:

$Revision: 6757 $

Author:

Julien Viet

Field Summary

Fields

Modifier and Type	Field	Description
static int	NO_CHANGE	No change have been done or attempted.
static int	UPDATE_FAILED	Attempts to update the state that failed has been performed.
static int	UPDATE_SUCCESSFUL	The state has been succesfully updated.

Fields inherited from interface org.gatein.pc.api.state.PropertyContext

PREFERENCES_ATTRIBUTE

Constructor Summary

Constructors

Constructor	Description
AbstractPropertyContext(org.gatein.pc.api.state.AccessMode access, org.gatein.pc.api.state.PropertyMap prefs, boolean render)	Create a new object.

Method Summary

Modifier and Type	Method	Description
Set<String>	getKeys()
org.gatein.pc.api.state.PropertyMap	getPrefs()
int	getStatus()
List<String>	getValue(String key)
boolean	isReadOnly()
void	update(org.gatein.pc.api.state.PropertyChange[] changes)

Methods inherited from class java.lang.Object

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

Field Detail

NO_CHANGE

public static final int NO_CHANGE

No change have been done or attempted.

See Also:

Constant Field Values

UPDATE_FAILED

public static final int UPDATE_FAILED

Attempts to update the state that failed has been performed.

See Also:

Constant Field Values

UPDATE_SUCCESSFUL

public static final int UPDATE_SUCCESSFUL

The state has been succesfully updated.

See Also:

Constant Field Values

Constructor Detail

AbstractPropertyContext

public AbstractPropertyContext(org.gatein.pc.api.state.AccessMode access,
                               org.gatein.pc.api.state.PropertyMap prefs,
                               boolean render)
                        throws IllegalArgumentException

Create a new object.

Parameters:

prefs - the user prefs

Throws:

IllegalArgumentException - if the portletPrefs are null

Method Detail

update

public void update(org.gatein.pc.api.state.PropertyChange[] changes)
            throws IllegalStateException

Specified by:

update in interface org.gatein.pc.api.state.PropertyContext

Throws:

IllegalStateException

getKeys

public Set<String> getKeys()

Specified by:

getKeys in interface org.gatein.pc.api.state.PropertyContext

getValue

public List<String> getValue(String key)
                      throws IllegalArgumentException

Specified by:

getValue in interface org.gatein.pc.api.state.PropertyContext

Throws:

IllegalArgumentException

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface org.gatein.pc.api.state.PropertyContext

getPrefs

public org.gatein.pc.api.state.PropertyMap getPrefs()

getStatus

public int getStatus()