Package org.gatein.pc.controller.state

Interface StateControllerContext

All Known Implementing Classes:

StateControllerContextImpl

public interface StateControllerContext

Author:

Julien Viet

Method Summary

Modifier and Type	Method	Description
Map<String,String[]>	getPublicWindowNavigationalState(ControllerContext controller, PageNavigationalState page, String windowId)	Obtain the public navigational state of a portlet window.
void	updatePublicNavigationalState(ControllerContext controller, PageNavigationalState page, String portletWindowId, Map<String,String[]> update)	Update the public navigational state of a portlet window.

Method Detail

updatePublicNavigationalState

void updatePublicNavigationalState(ControllerContext controller,
                                   PageNavigationalState page,
                                   String portletWindowId,
                                   Map<String,String[]> update)

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.

Parameters:

controller - the controller

page - the page

portletWindowId - the portlet window id

update - the updates

Throws:

IllegalArgumentException - if an argument is not valid

IllegalStateException - if the page state is read only

getPublicWindowNavigationalState

Map<String,String[]> getPublicWindowNavigationalState(ControllerContext controller,
                                                            PageNavigationalState page,
                                                            String windowId)

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.

Parameters:

controller - the controller

page - the page

windowId - the portlet window id @return the portlet public navigational state

Throws:

IllegalArgumentException - if an argument is not valid