lumis.service.pagepersonalization.widgetmanipulationaction

Interface WidgetManipulationAction

All Known Implementing Classes:

AddWidgetToHolderAction, MoveWidgetToHolderAction, RemoveWidgetAction

public interface WidgetManipulationAction

Interface that must be implemented by classes responsible for manipulating user widgets.

Since:

6.0.0

Version:

$Revision: 16824 $ $Date: 2015-01-23 20:49:12 +0000 (Fri, 23 Jan 2015) $

Method Summary

Modifier and Type	Method and Description
int	doAction(HttpServletRequest request, IPortalMode portalMode, ITransaction transaction) Performs necessary widget manipulation.

Method Detail

doAction

int doAction(HttpServletRequest request,
             IPortalMode portalMode,
             ITransaction transaction)
      throws PortalException

Performs necessary widget manipulation. Must return a HTTP status code to indicate if it was succeeded or not. It is not responsible of implementing classes to rollback or close the transaction. If the return code is different from HttpServletResponse.SC_OK, the caller will do the rollback automatically.

Parameters:

request - the HTTP servlet request.

portalMode - the current portal mode.

transaction - the transaction to be used.

Returns:

an HTTP status code.

Throws:

PortalException

Since:

6.0.0