|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PluggableActionResponse
Interface for the response of a pluggable action. Pluggable actions may set response parameters and a feedback message.
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 |
---|
java.lang.String getFeedbackMessage()
void setFeedbackMessage(java.lang.String feedbackMessage)
feedbackMessage
- The feedbackMessage to set.void setFeedbackMessageParameter(java.lang.String key, java.lang.Object value)
key
- key of the message parametervalue
- value of the message parameterjava.util.Map getFeedbackParameters()
java.lang.Object getParameter(java.lang.String key)
key
- key of the parameter
boolean isParameterSet(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 parameterjavax.portlet.ActionResponse getActionResponse()
javax.portlet.ResourceResponse getResourceResponse()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |