|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BaseStateParameterService
Base class for state parameters services that provides direct access to public render parameters.
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 |
---|
java.util.Map<javax.xml.namespace.QName,java.lang.String[]> getPublicParameters() throws StateParameterException
state
- the navigational state, not null
null
StateParameterException
java.util.Map<javax.xml.namespace.QName,java.lang.String[]> getPublicParameters(java.util.Collection<javax.xml.namespace.QName> keys) throws StateParameterException
keys
- set of keys to consider, not null
state
- the navigational state, not null
null
StateParameterException
java.util.Map<javax.xml.namespace.QName,java.lang.String[]> getPublicParameters(java.util.Collection<javax.xml.namespace.QName> keys, StateHolder state) throws StateParameterException
keys
- set of keys to consider, not null
state
- the navigational state, not null
null
StateParameterException
java.util.Map<javax.xml.namespace.QName,java.lang.String[]> getPublicParameters(StateHolder state) throws StateParameterException
state
- the navigational state, not null
null
StateParameterException
com.ibm.portal.state.service.parameters.PublicRenderParameterResolver getPublicRenderParameterResolver()
StateHolder getStateHolder()
boolean removePublicParameters(StateHolderController state, java.util.Collection<javax.xml.namespace.QName> keys) throws StateParameterException
state
- the navigational state, not null
keys
- set of keys to consider, not null
true
if the state was modified, else
false
StateParameterException
void setPublicParameters(StateHolderController state, java.util.Map<javax.xml.namespace.QName,java.lang.String[]> parameters) throws StateParameterException
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.
state
- the navigational state, not null
parameters
- parameters to set, not null
StateParameterException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |