Package de.xima.fc.workflow.event

Class AFormRecordEventData

java.lang.Object

de.xima.fc.workflow.event.AWorkflowEventData

de.xima.fc.workflow.event.AProjectEventData

de.xima.fc.workflow.event.AFormRecordEventData

All Implemented Interfaces:

IFormRecordProvidingEvent, IProjectProvidingEvent, IWorkflowEventData, Serializable

public abstract class AFormRecordEventData
extends AProjectEventData
implements IFormRecordProvidingEvent

POJO base class implementing the methods of IFormRecordProvidingEvent.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Vorgang	formRecord
protected IFormRecordLockContext	formRecordLockContext

Fields inherited from class de.xima.fc.workflow.event.AProjectEventData

project

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AFormRecordEventData(Mandant client, IUser user, Locale locale, Projekt project, Vorgang formRecord)	Deprecated. Use AFormRecordEventData(Mandant, IUser, Locale, Clock, Projekt, Vorgang).
protected	AFormRecordEventData(Mandant client, IUser user, Locale locale, Vorgang formRecord)	Deprecated. Use AFormRecordEventData(Mandant, IUser, Locale, Clock, Vorgang).
protected	AFormRecordEventData(Mandant client, IUser user, Locale locale, Clock clock, Projekt project, Vorgang formRecord)
protected	AFormRecordEventData(Mandant client, IUser user, Locale locale, Clock clock, Vorgang formRecord)

Method Summary

Modifier and Type	Method	Description
Vorgang	getFormRecord()
IFormRecordLockContext	getFormRecordLockContext()
protected org.apache.commons.lang3.builder.ToStringBuilder	getToStringBuilder()
void	update(Vorgang formRecord)

Methods inherited from class de.xima.fc.workflow.event.AProjectEventData

getProject, update

Methods inherited from class de.xima.fc.workflow.event.AWorkflowEventData

getClient, getClock, getLocale, getUserModel, toString

Methods inherited from class java.lang.Object

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

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

isAnonymize

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

Field Details

formRecord

protected Vorgang formRecord

formRecordLockContext

protected IFormRecordLockContext formRecordLockContext

Constructor Details

AFormRecordEventData

protected AFormRecordEventData(Mandant client,
 IUser user,
 Locale locale,
 Clock clock,
 Projekt project,
 Vorgang formRecord)

Parameters:

client - Client context for the workflow execution.

user - User who initiated the event.

locale - Locale to use during workflow execution for locale-sensitive operations.

clock - The clock to use for obtaining the current time.

project - Project for which to run the workflow.

formRecord - Form record for which to run the workflow.

Since:

8.0.0

AFormRecordEventData

protected AFormRecordEventData(Mandant client,
 IUser user,
 Locale locale,
 Clock clock,
 Vorgang formRecord)

Parameters:

client - Client context for the workflow execution.

user - User who initiated the event.

locale - Locale to use during workflow execution for locale-sensitive operations.

clock - The clock to use for obtaining the current time.

formRecord - Form record for which to run the workflow.

Since:

8.0.0

AFormRecordEventData

@Deprecated
protected AFormRecordEventData(Mandant client,
 IUser user,
 Locale locale,
 Projekt project,
 Vorgang formRecord)

Deprecated.

Use AFormRecordEventData(Mandant, IUser, Locale, Clock, Projekt, Vorgang).

Parameters:

client - Client context for the workflow execution.

user - User who initiated the event.

locale - Locale to use during workflow execution for locale-sensitive operations.

project - Project for which to run the workflow.

formRecord - Form record for which to run the workflow.

AFormRecordEventData

@Deprecated
protected AFormRecordEventData(Mandant client,
 IUser user,
 Locale locale,
 Vorgang formRecord)

Deprecated.

Use AFormRecordEventData(Mandant, IUser, Locale, Clock, Vorgang).

Parameters:

client - Client context for the workflow execution.

user - User who initiated the event.

locale - Locale to use during workflow execution for locale-sensitive operations.

formRecord - Form record for which to run the workflow.

Method Details

getFormRecord

public Vorgang getFormRecord()

Specified by:

getFormRecord in interface IFormRecordProvidingEvent

Returns:

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

getFormRecordLockContext

public IFormRecordLockContext getFormRecordLockContext()

Specified by:

getFormRecordLockContext in interface IFormRecordProvidingEvent

Returns:

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

update

public void update(Vorgang formRecord)

Specified by:

update in interface IFormRecordProvidingEvent

Parameters:

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

getToStringBuilder

protected org.apache.commons.lang3.builder.ToStringBuilder getToStringBuilder()

Overrides:

getToStringBuilder in class AProjectEventData