org.jboss.portal.portlet.test.tck
Class TCKPortletPageNavigationalState

java.lang.Object
  org.jboss.portal.portlet.test.tck.TCKPortletPageNavigationalState

All Implemented Interfaces:

PortletPageNavigationalState

public class TCKPortletPageNavigationalState
extends java.lang.Object
implements PortletPageNavigationalState

Version:

: 0.1 $

Author:

Boleslaw Dawidowicz

Constructor Summary

TCKPortletPageNavigationalState(PortletPageNavigationalState defaultState, java.util.Set<java.lang.String> involvedPortlets)

Method Summary

java.util.Set<java.lang.String>	getInvolvedPortlets()
java.util.Map<java.lang.String,java.lang.String[]>	getPortletPublicNavigationalState(java.lang.String portletWindowId) Obtain the public navigational state of a portlet window.
java.util.Set<java.lang.String>	getPortletWindowIds() Returns the portlet window ids referenced.
PortletWindowNavigationalState	getPortletWindowNavigationalState(java.lang.String portletWindowId) Returns the navigational state of a portlet window or null if it does not exist.
java.util.Set<javax.xml.namespace.QName>	getPublicNames() Returns the set of public names.
java.lang.String[]	getPublicNavigationalState(javax.xml.namespace.QName name) Returns a public navigational state entry or null if it is not found.
void	removePublicNavigationalState(javax.xml.namespace.QName name) Removes a public navigational state entry.
void	setPortletPublicNavigationalState(java.lang.String portletWindowId, java.util.Map<java.lang.String,java.lang.String[]> update) Update the public navigational state of a portlet window.
void	setPortletWindowNavigationalState(java.lang.String portletWindowId, PortletWindowNavigationalState portletWindowState) Update the navigational state of a portlet window.
void	setPublicNavigationalState(javax.xml.namespace.QName name, java.lang.String[] value) Sets a public navigational state entry.

Methods inherited from class java.lang.Object

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

Constructor Detail

TCKPortletPageNavigationalState

public TCKPortletPageNavigationalState(PortletPageNavigationalState defaultState,
                                       java.util.Set<java.lang.String> involvedPortlets)

Method Detail

getInvolvedPortlets

public java.util.Set<java.lang.String> getInvolvedPortlets()

getPortletWindowIds

public java.util.Set<java.lang.String> getPortletWindowIds()

Description copied from interface: PortletPageNavigationalState

Returns the portlet window ids referenced.

Specified by:

getPortletWindowIds in interface PortletPageNavigationalState

Returns:

a set of window id

getPortletWindowNavigationalState

public PortletWindowNavigationalState getPortletWindowNavigationalState(java.lang.String portletWindowId)
                                                                 throws java.lang.IllegalArgumentException

Description copied from interface: PortletPageNavigationalState

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

Specified by:

getPortletWindowNavigationalState in interface PortletPageNavigationalState

Parameters:

portletWindowId - the portlet window id

Returns:

the portlet window navigational state

Throws:

java.lang.IllegalArgumentException - if an argument is not valid

setPortletWindowNavigationalState

public void setPortletWindowNavigationalState(java.lang.String portletWindowId,
                                              PortletWindowNavigationalState portletWindowState)
                                       throws java.lang.IllegalArgumentException,
                                              java.lang.IllegalStateException

Description copied from interface: PortletPageNavigationalState

Update the navigational state of a portlet window.

Specified by:

setPortletWindowNavigationalState in interface PortletPageNavigationalState

Parameters:

portletWindowId - the portlet window id

portletWindowState - the portlet window state

Throws:

java.lang.IllegalArgumentException - if an argument is not valid

java.lang.IllegalStateException - if the page state is read only

getPortletPublicNavigationalState

public java.util.Map<java.lang.String,java.lang.String[]> getPortletPublicNavigationalState(java.lang.String portletWindowId)
                                                                                     throws java.lang.IllegalArgumentException

Description copied from interface: PortletPageNavigationalState

Obtain the public navigational state of a portlet window. The interpretation of what should be retrieved is left up to the implementor. An example of implementation would use the mapping between qnames and name provided by the referenced portlet info.

Specified by:

getPortletPublicNavigationalState in interface PortletPageNavigationalState

Parameters:

portletWindowId - the portlet window id

Returns:

the portlet public navigational state

Throws:

java.lang.IllegalArgumentException - if an argument is not valid

getPublicNames

public java.util.Set<javax.xml.namespace.QName> getPublicNames()

Description copied from interface: PortletPageNavigationalState

Returns the set of public names.

Specified by:

getPublicNames in interface PortletPageNavigationalState

Returns:

the public names

setPortletPublicNavigationalState

public void setPortletPublicNavigationalState(java.lang.String portletWindowId,
                                              java.util.Map<java.lang.String,java.lang.String[]> update)
                                       throws java.lang.IllegalArgumentException,
                                              java.lang.IllegalStateException

Description copied from interface: PortletPageNavigationalState

Update the public navigational state of a portlet window. The interpretation of what should be updated is left up to the implementor. An example of implementation would use the mapping between qname and name provided by the referenced portlet info.

The update argument values with a length of zero should be treated as removals.

Specified by:

setPortletPublicNavigationalState in interface PortletPageNavigationalState

Parameters:

portletWindowId - the portlet window id

update - the updates

Throws:

java.lang.IllegalArgumentException - if an argument is not valid

java.lang.IllegalStateException - if the page state is read only

getPublicNavigationalState

public java.lang.String[] getPublicNavigationalState(javax.xml.namespace.QName name)
                                              throws java.lang.IllegalArgumentException

Description copied from interface: PortletPageNavigationalState

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

Specified by:

getPublicNavigationalState in interface PortletPageNavigationalState

Parameters:

name - the name

Returns:

the entry value

Throws:

java.lang.IllegalArgumentException - if an argument is not valid

setPublicNavigationalState

public void setPublicNavigationalState(javax.xml.namespace.QName name,
                                       java.lang.String[] value)
                                throws java.lang.IllegalArgumentException,
                                       java.lang.IllegalStateException

Description copied from interface: PortletPageNavigationalState

Sets a public navigational state entry.

Specified by:

setPublicNavigationalState in interface PortletPageNavigationalState

Parameters:

name - the name

value - the new value

Throws:

java.lang.IllegalArgumentException - if an argument is not valid

java.lang.IllegalStateException - if the page state is read only

removePublicNavigationalState

public void removePublicNavigationalState(javax.xml.namespace.QName name)
                                   throws java.lang.IllegalArgumentException,
                                          java.lang.IllegalStateException

Description copied from interface: PortletPageNavigationalState

Removes a public navigational state entry.

Specified by:

removePublicNavigationalState in interface PortletPageNavigationalState

Parameters:

name - the name

Throws:

java.lang.IllegalArgumentException - if an argument is not valid

java.lang.IllegalStateException - if the page state is read only