Package lumis.doui.source.processaction

Class SourceUpdateMultiRowDataProcessActionHandler<S extends Source<?>>

java.lang.Object

lumis.doui.processaction.ProcessActionHandler<S>

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

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

All Implemented Interfaces:

IProcessActionHandler, IParameters

public class SourceUpdateMultiRowDataProcessActionHandler<S extends Source<?>>
extends BaseSourceProcessActionHandler<S>

Update process action handler for a multi row editor.

This process action handler should have the following nodes in its definition:

• totalRowsParameterId: the parameter id that holds the total number of rows posted.
• rowsDeletedParameterId: the parameter id that holds the primary keys of the rows that were deleted.

Example use of this process action <processAction id="commit" type="tableUpdateMultiRowData" sourceId="song"> <totalRowsParameterId>dataGrid.numberOfRows</totalRowsParameterId> <fieldValues> <fieldValue id="cdId" type="parameter">cdId</fieldValue> </fieldValues> <response type="doui_standardCommit"/> </processAction>

Since:

10.4.0

Version:

$Revision: 21292 $ $Date: 2018-05-10 15:35:12 -0300 (Thu, 10 May 2018) $

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	Description
SourceUpdateMultiRowDataProcessActionHandler()

Method Summary

Modifier and Type	Method	Description
protected void	addRow()
protected void	deleteRows(java.util.Collection<java.lang.String> rowsDeleted)
void	doAction()	Performs the source operation.
protected int	getCurrentRowNumber()	Returns the number of current row being processed, 1-based.
java.lang.Object	getParameter(java.lang.String name)	Returns the parameter value from.
protected java.lang.String	getRowNumberFieldId()	Returns the identifier of the field to store the row number.
void	init(org.w3c.dom.Node processActionNode, ProcessActionContainer processActionContainer)	Called by the process action container to initialize the process action.
void	setParameter(java.lang.String name, java.lang.Object value)	This method overrides the parent method including the current row number id in the parameter name.
protected void	updateRow()

Methods inherited from class lumis.doui.source.processaction.BaseSourceProcessActionHandler

isSendRenderDataChangedNotificationEnabled, processAction

Methods inherited from class lumis.doui.processaction.ProcessActionHandler

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceUpdateMultiRowDataProcessActionHandler

public SourceUpdateMultiRowDataProcessActionHandler()

Method Detail

init

public void init(org.w3c.dom.Node processActionNode,
                 ProcessActionContainer processActionContainer)
          throws PortalException

Description copied from interface: IProcessActionHandler

Called by the process action container to initialize the process action.

The process action node is a copy of the node specified in the doui definition.

Specified by:

init in interface IProcessActionHandler

Overrides:

init in class ProcessActionHandler<S extends Source<?>>

Throws:

PortalException

doAction

public void doAction()
              throws PortalException

Description copied from class: BaseSourceProcessActionHandler

Performs the source operation.

Specified by:

doAction in class BaseSourceProcessActionHandler<S extends Source<?>>

Throws:

PortalException

deleteRows

protected void deleteRows(java.util.Collection<java.lang.String> rowsDeleted)
                   throws PortalException

Throws:

PortalException

addRow

protected void addRow()
               throws PortalException

Throws:

PortalException

updateRow

protected void updateRow()
                  throws PortalException

Throws:

PortalException

getParameter

public java.lang.Object getParameter(java.lang.String name)

Returns the parameter value from. The current row number is a local variable that is prefixed to the data value.

Specified by:

getParameter in interface IParameters

Specified by:

getParameter in interface IProcessActionHandler

Overrides:

getParameter in class ProcessActionHandler<S extends Source<?>>

Parameters:

name - name of the parameter value to be returned

setParameter

public void setParameter(java.lang.String name,
                         java.lang.Object value)

This method overrides the parent method including the current row number id in the parameter name.

Specified by:

setParameter in interface IProcessActionHandler

Overrides:

setParameter in class ProcessActionHandler<S extends Source<?>>

getRowNumberFieldId

protected java.lang.String getRowNumberFieldId()

Returns the identifier of the field to store the row number.

Returns:

the field identifier, or null if there is no field to store the row number.

Since:

10.4.0

getCurrentRowNumber

protected int getCurrentRowNumber()

Returns the number of current row being processed, 1-based.

Returns:

the number of current row being processed, 1-based.

Since:

10.4.0