Package lumis.doui.source.event

Class SourcePreUpdateDataEvent

java.lang.Object

lumis.portal.event.AbstractPortalEvent

lumis.portal.event.AbstractTransactionalPortalEvent

lumis.doui.source.event.SourceUpdateDataEvent

lumis.doui.source.event.SourcePreUpdateDataEvent

All Implemented Interfaces:

IPortalEvent

@StableMinor(version="17.0",
             sinceVersion="10.4")
public class SourcePreUpdateDataEvent
extends SourceUpdateDataEvent

Event raised by Source before data is updated.

Since:

10.4.0

Version:

$Revision$ $Date$

Constructor Summary

Constructors

Constructor	Description
SourcePreUpdateDataEvent(Source<?> source, IParameters parameters, java.lang.String itemId)	Creates a new event for update of source data.

Method Summary

Modifier and Type	Method	Description
java.util.List<ISourceData>	getOriginalData()	Returns the data that corresponds to the item identifier being updated.
void	setParameters(IParameters parameters)	Sets the data parameters provided to the update operation.

Methods inherited from class lumis.doui.source.event.SourceUpdateDataEvent

getOriginalItemId, getParameters, getSource

Methods inherited from class lumis.portal.event.AbstractTransactionalPortalEvent

getSessionConfig, getTransaction

Methods inherited from class lumis.portal.event.AbstractPortalEvent

getEventGroups, getOperationType, setEventGroups, setOperationType

Methods inherited from class java.lang.Object

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

Methods inherited from interface lumis.portal.event.IPortalEvent

toString

Constructor Detail

SourcePreUpdateDataEvent

public SourcePreUpdateDataEvent(Source<?> source,
                                IParameters parameters,
                                java.lang.String itemId)

Creates a new event for update of source data.

Parameters:

source - the source.

parameters - the data provided to the update operation as parameters.

itemId - the item identifier of the data being updated.

Since:

10.4.0

Method Detail

getOriginalData

public java.util.List<ISourceData> getOriginalData()

Returns the data that corresponds to the item identifier being updated.

This method may require reading the data from the persistence. So if the required information is available using another method of this event, it may be more efficient to use that other method.

Returns:

the data returned by Source.readData(String...) for SourceUpdateDataEvent.getOriginalItemId(). For optimizations purpose, the returned data is reused on multiple calls to this method and it must not be modified to prevent incorrect result on future calls to this method.

Since:

10.4.0

setParameters

public void setParameters(IParameters parameters)

Sets the data parameters provided to the update operation. If the parameters are changed, the update operation will use the newly set parameters.

Parameters:

parameters - the data to use for update.

Since:

17.0.0