com.gentics.api.portalnode.action
Interface PluggableActionRequest


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

Author:
norbert

Method Summary
 Object getParameter(String key)
          get the value of the parameter identified by key
 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(String key)
          check whether the parameter with given key is required
 boolean isParameterSet(String key)
          check whether the parameter identified by key is set
 void setParameter(String key, Object value)
          set the parameter to the given value
 void unsetParameter(String key)
          unset the parameter (set it to null)
 

Method Detail

getParameter

Object getParameter(String key)
get the value of the parameter identified by key

Parameters:
key - key of the parameter
Returns:
value of the parameter or null if the parameter is not set

isParameterSet

boolean isParameterSet(String key)
check whether the parameter identified by key is set

Parameters:
key - key of the parameter
Returns:
true when the parameter is set, false if not

isParameterRequired

boolean isParameterRequired(String key)
check whether the parameter with given key is required

Parameters:
key - key of the parameter
Returns:
true when the parameter is required, false if not (or not existent)

getParameterNames

Set getParameterNames()
get the set of parameter keys

Returns:
set of parameter keys

setParameter

void setParameter(String key,
                  Object value)
set the parameter to the given value

Parameters:
key - key of the parameter
value - new value of the parameter, null unsets the parameter

unsetParameter

void unsetParameter(String key)
unset the parameter (set it to null)

Parameters:
key - key of the parameter

isConsistent

boolean isConsistent()
check whether the input data is consistent (whether all required parameters are set)

Returns:
true when the data is consistent, false if not

getPortletRequest

javax.portlet.PortletRequest getPortletRequest()
get the originating portlet request

Returns:
portlet request


Copyright © 2013 Gentics Software GmbH. All Rights Reserved.