com.liferay.portal.kernel.portlet.bridges.mvc

Class BaseMVCActionCommand

java.lang.Object

com.liferay.portal.kernel.portlet.bridges.mvc.BaseMVCActionCommand

All Implemented Interfaces:

MVCActionCommand, MVCCommand

Direct Known Subclasses:

BaseFormMVCActionCommand

public abstract class BaseMVCActionCommand
extends java.lang.Object
implements MVCActionCommand

Author:

Brian Wing Shun Chan

See Also:

PortletAction

Field Summary

Fields inherited from interface com.liferay.portal.kernel.portlet.bridges.mvc.MVCActionCommand

EMPTY

Constructor Summary

Constructors

Constructor and Description
BaseMVCActionCommand()

Method Summary

Modifier and Type	Method and Description
protected void	addDeleteSuccessData(javax.portlet.PortletRequest portletRequest, java.lang.Object data)
protected void	addSuccessMessage(javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)
protected abstract void	doProcessAction(javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)
protected javax.portlet.PortletConfig	getPortletConfig(javax.portlet.PortletRequest portletRequest)
protected void	hideDefaultErrorMessage(javax.portlet.PortletRequest portletRequest)
protected void	hideDefaultSuccessMessage(javax.portlet.PortletRequest portletRequest)
protected boolean	isDisplaySuccessMessage(javax.portlet.PortletRequest portletRequest)
boolean	processAction(javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse) Invoked by MVCPortlet to allow the portlet to process an action request.
protected boolean	redirectToLogin(javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)
protected void	sendRedirect(javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)
protected void	sendRedirect(javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse, java.lang.String redirect)
protected void	sendRedirect(javax.portlet.PortletConfig portletConfig, javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse, java.lang.String redirect, java.lang.String closeRedirect)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseMVCActionCommand

public BaseMVCActionCommand()

Method Detail

processAction

public boolean processAction(javax.portlet.ActionRequest actionRequest,
                             javax.portlet.ActionResponse actionResponse)
                      throws javax.portlet.PortletException

Description copied from interface: MVCActionCommand

Invoked by MVCPortlet to allow the portlet to process an action request.

Specified by:

processAction in interface MVCActionCommand

Parameters:

actionRequest - the action request

actionResponse - the action response

Returns:

true if an error occurs in processing the action request; false otherwise

Throws:

javax.portlet.PortletException

addDeleteSuccessData

protected void addDeleteSuccessData(javax.portlet.PortletRequest portletRequest,
                                    java.lang.Object data)

addSuccessMessage

protected void addSuccessMessage(javax.portlet.ActionRequest actionRequest,
                                 javax.portlet.ActionResponse actionResponse)

doProcessAction

protected abstract void doProcessAction(javax.portlet.ActionRequest actionRequest,
                                        javax.portlet.ActionResponse actionResponse)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getPortletConfig

protected javax.portlet.PortletConfig getPortletConfig(javax.portlet.PortletRequest portletRequest)

hideDefaultErrorMessage

protected void hideDefaultErrorMessage(javax.portlet.PortletRequest portletRequest)

hideDefaultSuccessMessage

protected void hideDefaultSuccessMessage(javax.portlet.PortletRequest portletRequest)

isDisplaySuccessMessage

protected boolean isDisplaySuccessMessage(javax.portlet.PortletRequest portletRequest)

redirectToLogin

protected boolean redirectToLogin(javax.portlet.ActionRequest actionRequest,
                                  javax.portlet.ActionResponse actionResponse)
                           throws java.io.IOException

Throws:

java.io.IOException

sendRedirect

protected void sendRedirect(javax.portlet.ActionRequest actionRequest,
                            javax.portlet.ActionResponse actionResponse)
                     throws java.io.IOException

Throws:

java.io.IOException

sendRedirect

protected void sendRedirect(javax.portlet.ActionRequest actionRequest,
                            javax.portlet.ActionResponse actionResponse,
                            java.lang.String redirect)
                     throws java.io.IOException

Throws:

java.io.IOException

sendRedirect

protected void sendRedirect(javax.portlet.PortletConfig portletConfig,
                            javax.portlet.ActionRequest actionRequest,
                            javax.portlet.ActionResponse actionResponse,
                            java.lang.String redirect,
                            java.lang.String closeRedirect)
                     throws java.io.IOException

Throws:

java.io.IOException