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

All Superinterfaces:

Disposable, Identifiable

All Known Subinterfaces:

ContentNodeStateParameterService, PortletWindowStateParameterService

public interface BaseStateParameterService
extends Identifiable, Disposable

Base class for state parameters services that provides direct access to public render parameters.

Since:

8.0

Method Summary

java.util.Map<javax.xml.namespace.QName,java.lang.String[]>	getPublicParameters() Returns a map of all public render parameters in the state for the current scope on the state of the current request.
java.util.Map<javax.xml.namespace.QName,java.lang.String[]>	getPublicParameters(java.util.Collection<javax.xml.namespace.QName> keys) Returns a map of the public render parameters with the given keys in the current scope on the state of the current request.
java.util.Map<javax.xml.namespace.QName,java.lang.String[]>	getPublicParameters(java.util.Collection<javax.xml.namespace.QName> keys, StateHolder state) Returns a map of the public render parameters with the given keys in the current scope.
java.util.Map<javax.xml.namespace.QName,java.lang.String[]>	getPublicParameters(StateHolder state) Returns a map of all public render parameters in the state for the current scope.
com.ibm.portal.state.service.parameters.PublicRenderParameterResolver	getPublicRenderParameterResolver() Returns the resolver associated with this service
StateHolder	getStateHolder() Method that can be used to obtain the state holder this service operates on.
boolean	removePublicParameters(StateHolderController state, java.util.Collection<javax.xml.namespace.QName> keys) Removes the public render parameters with the given keys from the current scope.
void	setPublicParameters(StateHolderController state, java.util.Map<javax.xml.namespace.QName,java.lang.String[]> parameters) Sets the given public render parameters for the current scope.

Methods inherited from interface com.ibm.portal.Identifiable

getObjectID

Methods inherited from interface com.ibm.portal.Disposable

dispose

Method Detail

getPublicParameters

java.util.Map<javax.xml.namespace.QName,java.lang.String[]> getPublicParameters()
                                                                                throws StateParameterException

Returns a map of all public render parameters in the state for the current scope on the state of the current request.

Parameters:

state - the navigational state, not null

Returns:

the render parameter map, not null

Throws:

StateParameterException

Since:

8.5

getPublicParameters

java.util.Map<javax.xml.namespace.QName,java.lang.String[]> getPublicParameters(java.util.Collection<javax.xml.namespace.QName> keys)
                                                                                throws StateParameterException

Returns a map of the public render parameters with the given keys in the current scope on the state of the current request.

Parameters:

keys - set of keys to consider, not null

state - the navigational state, not null

Returns:

the render parameter map, not null

Throws:

StateParameterException

Since:

8.5

getPublicParameters

java.util.Map<javax.xml.namespace.QName,java.lang.String[]> getPublicParameters(java.util.Collection<javax.xml.namespace.QName> keys,
                                                                                StateHolder state)
                                                                                throws StateParameterException

Returns a map of the public render parameters with the given keys in the current scope.

Parameters:

keys - set of keys to consider, not null

state - the navigational state, not null

Returns:

the render parameter map, not null

Throws:

StateParameterException

getPublicParameters

java.util.Map<javax.xml.namespace.QName,java.lang.String[]> getPublicParameters(StateHolder state)
                                                                                throws StateParameterException

Returns a map of all public render parameters in the state for the current scope.

Parameters:

state - the navigational state, not null

Returns:

the render parameter map, not null

Throws:

StateParameterException

getPublicRenderParameterResolver

com.ibm.portal.state.service.parameters.PublicRenderParameterResolver getPublicRenderParameterResolver()

Returns the resolver associated with this service

Returns:

the resolver

Since:

8.5

getStateHolder

StateHolder getStateHolder()

Method that can be used to obtain the state holder this service operates on.

Returns:

The state holder.

removePublicParameters

boolean removePublicParameters(StateHolderController state,
                               java.util.Collection<javax.xml.namespace.QName> keys)
                               throws StateParameterException

Removes the public render parameters with the given keys from the current scope. Render parameters with different keys are unaffected.

Parameters:

state - the navigational state, not null

keys - set of keys to consider, not null

Returns:

true if the state was modified, else false

Throws:

StateParameterException

setPublicParameters

void setPublicParameters(StateHolderController state,
                         java.util.Map<javax.xml.namespace.QName,java.lang.String[]> parameters)
                         throws StateParameterException

Sets the given public render parameters for the current scope. Those parameters in the map with non-null values will set new public render parameter or replace an existing parameter. Parameters with null values will be deleted from the set of render parameters. Public render parameters with keys that are not part of the key set of the parameter object will remain unaffected.

Parameters:

state - the navigational state, not null

parameters - parameters to set, not null

Throws:

StateParameterException