|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PluggableActionRequest
input data passed to
PluggableAction.processAction(PluggableActionRequest, PluggableActionResponse)
. the data may
be modified by the action - and the modified data passed to a following
action
Method Summary | |
---|---|
java.lang.Object |
getParameter(java.lang.String key)
get the value of the parameter identified by key |
java.util.Set |
getParameterNames()
get the set of parameter keys |
javax.portlet.PortletRequest |
getPortletRequest()
get the originating portlet request |
boolean |
isConsistent()
check whether the input data is consistent (whether all required parameters are set) |
boolean |
isParameterRequired(java.lang.String key)
check whether the parameter with given key is required |
boolean |
isParameterSet(java.lang.String key)
check whether the parameter identified by key is set |
void |
setParameter(java.lang.String key,
java.lang.Object value)
set the parameter to the given value |
void |
unsetParameter(java.lang.String key)
unset the parameter (set it to null) |
Method Detail |
---|
java.lang.Object getParameter(java.lang.String key)
key
- key of the parameter
boolean isParameterSet(java.lang.String key)
key
- key of the parameter
boolean isParameterRequired(java.lang.String key)
key
- key of the parameter
java.util.Set getParameterNames()
void setParameter(java.lang.String key, java.lang.Object value)
key
- key of the parametervalue
- new value of the parameter, null unsets the parametervoid unsetParameter(java.lang.String key)
key
- key of the parameterboolean isConsistent()
javax.portlet.PortletRequest getPortletRequest()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |