Package org.gatein.pc.controller.state

Class PageNavigationalState

java.lang.Object

org.gatein.pc.controller.state.PageNavigationalState

public final class PageNavigationalState
extends Object

Defines the page navigational state view that the controller needs to operate on. Its name begins with page however it does not mandate that the represented context to be a page. I.E it could represent a set of physical pages or something else.

Version:

$Revision: 1.1 $

Author:

Julien Viet

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<QName,String[]>	page	.
protected Map<String,WindowNavigationalState>	windows	.

Constructor Summary

Constructors

Constructor	Description
PageNavigationalState(boolean modifiable)
PageNavigationalState(PageNavigationalState original, boolean modifiable)

Method Summary

Modifier and Type	Method	Description
Set<QName>	getPublicNames()	Returns the set of public names.
String[]	getPublicNavigationalState(QName name)	Returns a public navigational state entry or null if it is not found.
Set<String>	getWindowIds()	Returns the window ids referenced.
WindowNavigationalState	getWindowNavigationalState(String windowId)	Returns the navigational state of a portlet window or null if it does not exist.
void	removePublicNavigationalState(QName name)	Removes a public navigational state entry.
void	setPublicNavigationalState(QName name, String[] value)	Sets a public navigational state entry.
void	setWindowNavigationalState(String windowId, WindowNavigationalState windowState)	Update the navigational state of a portlet window.

Methods inherited from class java.lang.Object

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

Field Detail

windows

protected final Map<String,WindowNavigationalState> windows

.

page

protected final Map<QName,String[]> page

.

Constructor Detail

PageNavigationalState

public PageNavigationalState(boolean modifiable)

PageNavigationalState

public PageNavigationalState(PageNavigationalState original,
                             boolean modifiable)

Method Detail

getWindowIds

public Set<String> getWindowIds()

Returns the window ids referenced.

Returns:

a set of window id

getWindowNavigationalState

public WindowNavigationalState getWindowNavigationalState(String windowId)
                                                   throws IllegalArgumentException

Returns the navigational state of a portlet window or null if it does not exist.

Parameters:

windowId - the portlet window id

Returns:

the portlet window navigational state

Throws:

IllegalArgumentException - if an argument is not valid

setWindowNavigationalState

public void setWindowNavigationalState(String windowId,
                                       WindowNavigationalState windowState)
                                throws IllegalArgumentException,
                                       IllegalStateException

Update the navigational state of a portlet window.

Parameters:

windowId - the portlet window id

windowState - the portlet window state

Throws:

IllegalArgumentException - if an argument is not valid

IllegalStateException - if the page state is read only

getPublicNames

public Set<QName> getPublicNames()

Returns the set of public names.

Returns:

the public names

getPublicNavigationalState

public String[] getPublicNavigationalState(QName name)
                                    throws IllegalArgumentException

Returns a public navigational state entry or null if it is not found.

Parameters:

name - the name

Returns:

the entry value

Throws:

IllegalArgumentException - if an argument is not valid

setPublicNavigationalState

public void setPublicNavigationalState(QName name,
                                       String[] value)
                                throws IllegalArgumentException,
                                       IllegalStateException

Sets a public navigational state entry.

Parameters:

name - the name

value - the new value

Throws:

IllegalArgumentException - if an argument is not valid

IllegalStateException - if the page state is read only

removePublicNavigationalState

public void removePublicNavigationalState(QName name)
                                   throws IllegalArgumentException,
                                          IllegalStateException

Removes a public navigational state entry.

Parameters:

name - the name

Throws:

IllegalArgumentException - if an argument is not valid

IllegalStateException - if the page state is read only