com.gentics.api.portalnode.action
Interface PluggableActionResponse


public interface PluggableActionResponse

Interface for the response of a pluggable action. Pluggable actions may set response parameters and a feedback message.

Author:
norbert

Method Summary
 javax.portlet.ActionResponse getActionResponse()
          Get the action response of the handled portlet action, may be null when the pluggable action is done in the render phase or in the serve resource phase
 java.lang.String getFeedbackMessage()
          Get the feedback message
 java.util.Map getFeedbackParameters()
          Get all set feedback parameters
 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.ResourceResponse getResourceResponse()
          Get the resource response of the handled portlet action, may be null when the pluggable action is done in the render phase or in the action phase
 boolean isParameterSet(java.lang.String key)
          Check whether the parameter identified by key is set
 void setFeedbackMessage(java.lang.String feedbackMessage)
          Set a new feedback message
 void setFeedbackMessageParameter(java.lang.String key, java.lang.Object value)
          Set a feedback message parameter
 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

getFeedbackMessage

java.lang.String getFeedbackMessage()
Get the feedback message

Returns:
Returns the feedbackMessage.

setFeedbackMessage

void setFeedbackMessage(java.lang.String feedbackMessage)
Set a new feedback message

Parameters:
feedbackMessage - The feedbackMessage to set.

setFeedbackMessageParameter

void setFeedbackMessageParameter(java.lang.String key,
                                 java.lang.Object value)
Set a feedback message parameter

Parameters:
key - key of the message parameter
value - value of the message parameter

getFeedbackParameters

java.util.Map getFeedbackParameters()
Get all set feedback parameters

Returns:
feedback parameters as map

getParameter

java.lang.Object getParameter(java.lang.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(java.lang.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

getParameterNames

java.util.Set getParameterNames()
Get the set of parameter keys

Returns:
set of parameter keys

setParameter

void setParameter(java.lang.String key,
                  java.lang.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(java.lang.String key)
Unset the parameter (set it to null)

Parameters:
key - key of the parameter

getActionResponse

javax.portlet.ActionResponse getActionResponse()
Get the action response of the handled portlet action, may be null when the pluggable action is done in the render phase or in the serve resource phase

Returns:
action response or null

getResourceResponse

javax.portlet.ResourceResponse getResourceResponse()
Get the resource response of the handled portlet action, may be null when the pluggable action is done in the render phase or in the action phase

Returns:
resource response or null


Copyright © 2013 Gentics Software GmbH. All Rights Reserved.