Package lumis.doui.source.processaction

Class SourceAddMultiRowDataProcessActionHandler<S extends Source<?>>

java.lang.Object

lumis.doui.processaction.ProcessActionHandler<S>

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

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

All Implemented Interfaces:

IProcessActionHandler, IParameters

Direct Known Subclasses:

BoostSearchProcessActionHandler

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

Process Action Handler to add multiple rows.

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

• totalRowsParameterId: the parameter id that holds the total number of rows posted.

Example use of this process action <processAction id="commit" type="tableAddMultiRowData" sourceId="song"> <fieldValues> <fieldValue id="cdId" type="responseRenderParameter">PAGE_PARAMETER_ITEMID</fieldValue> </fieldValues> <response type="doui_standardCommit"/> </processAction>

Since:

10.4.0

Version:

$Revision$ $Date$

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
SourceAddMultiRowDataProcessActionHandler()

Method Summary

Modifier and Type	Method	Description
protected void	doAction()	This method calls the Source.addData(Object) for each row.
protected int	getCurrentRowNumber()	Returns the number of current row being processed, 1-based.
java.lang.Object	getParameter(java.lang.String name)	This method overrides the parent method returning the appropriate value for the current row being added.
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.

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

SourceAddMultiRowDataProcessActionHandler

public SourceAddMultiRowDataProcessActionHandler()

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

protected void doAction()
                 throws PortalException

This method calls the Source.addData(Object) for each row.

Specified by:

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

Throws:

PortalException

getParameter

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

This method overrides the parent method returning the appropriate value for the current row being added.

Specified by:

getParameter in interface IParameters

Specified by:

getParameter in interface IProcessActionHandler

Overrides:

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

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