lumis.doui.source.processaction

Class BaseSourceProcessActionHandler<S extends Source<?>>

java.lang.Object

lumis.doui.processaction.ProcessActionHandler<S>

lumis.doui.source.processaction.BaseSourceProcessActionHandler<S>

All Implemented Interfaces:

IProcessActionHandler, IParameters

Direct Known Subclasses:

SourceAddDataProcessActionHandler, SourceAddFileMultiRowDataProcessActionHandler, SourceAddMultiRowDataProcessActionHandler, SourceDeleteDataProcessActionHandler, SourceUpdateDataProcessActionHandler, SourceUpdateMultiRowDataProcessActionHandler

@StableMinor(version="12.5",
             sinceVersion="10.4")
public abstract class BaseSourceProcessActionHandler<S extends Source<?>>
extends ProcessActionHandler<S>

Base implementation for source basic operation process action handlers.

Source's render data changed notification is disabled during the execution of this process action handler if isSendRenderDataChangedNotificationEnabled() returns false.

doAction() is to be implemented by overriding class to execute the source operation.

This process action handler calls ProcessActionHandler.addDefaultResponse() after executing doAction().

Since:

10.4.0

Version:

$Revision: 24140 $ $Date: 2020-09-14 21:50:42 +0000 (Mon, 14 Sep 2020) $

Field Summary

Fields inherited from class lumis.doui.processaction.ProcessActionHandler

douiContext, id, localizationManager, parameters, processActionContainer, processActionNode, RESPONSE_TYPE_CLOSE_WINDOW, RESPONSE_TYPE_HYPERLINK, RESPONSE_TYPE_MESSAGE, RESPONSE_TYPE_POPUP_INTERFACE, RESPONSE_TYPE_PREVIEW, RESPONSE_TYPE_REFRESH_PARENT, RESPONSE_TYPE_REQUEST_PROCESS_ACTION_CONFIRMATION_MESSAGE, RESPONSE_TYPE_REQUEST_PROCESS_ACTION_CONFIRMATION_PROCESS_ACTION_ID, RESPONSE_TYPE_RUN_JAVASCRIPT, RESPONSE_TYPE_SET_REQUEST_ATTRIBUTES, RESPONSE_TYPE_SET_REQUEST_PARAMETERS, RESPONSE_TYPE_SET_RESPONSE_PARAMETERS, RESPONSE_TYPE_STANDARD_COMMIT, RESPONSE_TYPE_STANDARD_EMBEDDED, RESPONSE_TYPE_STANDARD_POPUP, RESPONSE_TYPE_VALIDATE_PROCESS_ACTION_ON_RENDER, sessionConfig, source, sourceContainer, transaction

Constructor Summary

Constructors

Constructor and Description
BaseSourceProcessActionHandler()

Method Summary

Modifier and Type	Method and Description
protected abstract void	doAction() Performs the source operation.
protected boolean	isSendRenderDataChangedNotificationEnabled() Indicates if this process action is to send render data changed notification.
void	processAction() Executes the process action.

Methods inherited from class lumis.doui.processaction.ProcessActionHandler

addDefaultResponse, addResponseParameter, checkServiceInstancePermission, checkServiceInstancePermission, containsParameter, getId, getParameter, getParameter, getResource, getServiceInterfaceHyperLink, getUrl, init, localize, processHyperLinkResponse, processPopupInterfaceResponse, resolveFieldValueNode, setParameter

Methods inherited from class java.lang.Object

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

Methods inherited from interface lumis.util.parameter.IParameters

asParameters, emptyParameters

Constructor Detail

BaseSourceProcessActionHandler

public BaseSourceProcessActionHandler()

Method Detail

processAction

public void processAction()
                   throws PortalException

Description copied from interface: IProcessActionHandler

Executes the process action.

This method may execute the process action based on the parameters and node specifications passed to it earlier.

Throws:

PortalException

doAction

protected abstract void doAction()
                          throws PortalException

Performs the source operation.

Throws:

PortalException

Since:

10.4.0

isSendRenderDataChangedNotificationEnabled

protected boolean isSendRenderDataChangedNotificationEnabled()
                                                      throws PortalException

Indicates if this process action is to send render data changed notification.

The default implementation of this method returns the value specified in this process action handler's definition on element sendRenderDataChangedNotification. If such element is not present, a true value is returned.

Returns:

true if this process action is to send render data changed notification, false otherwise.

Throws:

PortalException

Since:

10.4.0