com.ibm.portal.state.service.parameters
Interface StateParameterService

All Superinterfaces:

Disposable

public interface StateParameterService
extends Disposable

Base interface for obtaining a service that allows easy obtaining, setting and removing of parameters for a given portlet on a given page.

Since:

6.1.0

Method Summary

ContentNodeStateParameterService	getContentNodeStateParameterService(ContentNode node) Returns a service that allows manipulation of public parameters for the given content node.
ContentNodeStateParameterService	getContentNodeStateParameterService(ObjectID nodeID) Returns a service that allows manipulation of public parameters for the given content node.
PortletWindowStateParameterService	getPortletWindowStateParameterService(ObjectID portletWindowID, ObjectID pageID) Returns a service that allows manipulation of parameters for the given portlet window.
PortletWindowStateParameterService	getPortletWindowStateParameterService(PortletWindow portletWindow, ContentPage page) Returns a service that allows manipulation of parameters for the given portlet window.

Methods inherited from interface com.ibm.portal.Disposable

dispose

Method Detail

getContentNodeStateParameterService

ContentNodeStateParameterService getContentNodeStateParameterService(ContentNode node)
                                                                     throws StateParameterException

Returns a service that allows manipulation of public parameters for the given content node.

Parameters:

nodeID - The ObjectID of the page. Must not be null.

Returns:

A service for manipulating parameters or null if the content page with the given ObjectID could not be found.

Throws:

StateParameterException - thrown if the initialization of the PortletWindowStateParameterService fails.

Since:

8.0

getContentNodeStateParameterService

ContentNodeStateParameterService getContentNodeStateParameterService(ObjectID nodeID)
                                                                     throws StateParameterException

Returns a service that allows manipulation of public parameters for the given content node.

Parameters:

nodeID - The ObjectID of the page. Must not be null.

Returns:

A service for manipulating parameters or null if the content page with the given ObjectID could not be found.

Throws:

StateParameterException - thrown if the initialization of the PortletWindowStateParameterService fails.

Since:

8.0

getPortletWindowStateParameterService

PortletWindowStateParameterService getPortletWindowStateParameterService(ObjectID portletWindowID,
                                                                         ObjectID pageID)
                                                                         throws StateParameterException

Returns a service that allows manipulation of parameters for the given portlet window.

Parameters:

portletWindowID - ObjectID of a specific portlet window whose parameters should be changed. Must not be null.

pageID - The ObjectID of the portlet window's content page. Must not be null.

Returns:

A service for manipulating parameters or null if the content page with the given ObjectID could not be found.

Throws:

StateParameterException - thrown if the initialization of the PortletWindowStateParameterService fails.

getPortletWindowStateParameterService

PortletWindowStateParameterService getPortletWindowStateParameterService(PortletWindow portletWindow,
                                                                         ContentPage page)
                                                                         throws StateParameterException

Returns a service that allows manipulation of parameters for the given portlet window.

Parameters:

portletWindow - a specific portlet window whose parameters should be changed. Must not be null.

page - The portlet window's content page. Must not be null.

Returns:

A service for manipulating parameters

Throws:

StateParameterException - thrown if the initialization of the PortletWindowStateParameterService fails.