Package de.xima.fc.interfaces.workflow.event

Interface IFormRecordProvidingEvent

All Superinterfaces:

IProjectProvidingEvent, IWorkflowEventData, Serializable

All Known Subinterfaces:

IDoiVerifiedEventData, IFormSubmissionEvent, IInvitationErrorEventData, IInvitationSentEventData, IUnhandledExceptionEventData

All Known Implementing Classes:

AFormRecordEventData

public interface IFormRecordProvidingEvent
extends IProjectProvidingEvent

Interface for IWorkflowEventData that belong to a form record, such a when a form is submitted, or when the active WorkflowState of a form record changes.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
Vorgang	getFormRecord()
default IFormRecordLockContext	getFormRecordLockContext()
Boolean	isAnonymize()
void	update(Vorgang formRecord)

Methods inherited from interface de.xima.fc.interfaces.workflow.event.IProjectProvidingEvent

getProject, update

Methods inherited from interface de.xima.fc.interfaces.workflow.event.IWorkflowEventData

getClient, getClock, getDefaultSystemState, getLocale, getUser, getUserModel, getWorkflowExecutionPostProcessors

Method Details

getFormRecord

Vorgang getFormRecord()

Returns:

The project of the event. Only triggers belonging to the Vorgang.getWorkflowVersion() are fired.

getFormRecordLockContext

default IFormRecordLockContext getFormRecordLockContext()

Returns:

the context that is locking the form record. May be null

Since:

7.0.5

isAnonymize

Boolean isAnonymize()

Returns:

Whether data specific to the user who submitted the form should be anonymized. When null, an appropriate default should be used: true when the Projekt.isAnonymize() requires it, or false otherwise.

update

void update(Vorgang formRecord)

Parameters:

formRecord - Updates the form record. This will always be the same project, but may reflect a new state in the database.