Package de.xima.fc.workflow.event

Class AWorkflowEventData

java.lang.Object

de.xima.fc.workflow.event.AWorkflowEventData

All Implemented Interfaces:

IWorkflowEventData, Serializable

Direct Known Subclasses:

AProjectEventData

public abstract class AWorkflowEventData
extends Object
implements IWorkflowEventData

Base POJO class that can be used (but does not have to be) for implementations of IWorkflowEventData.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AWorkflowEventData(Mandant client, IUser user, Locale locale)	Deprecated. Use AWorkflowEventData(Mandant, IUser, Locale, Clock)
protected	AWorkflowEventData(Mandant client, IUser user, Locale locale, Clock clock)

Method Summary

Modifier and Type	Method	Description
Mandant	getClient()
Clock	getClock()
Locale	getLocale()
protected org.apache.commons.lang3.builder.ToStringBuilder	getToStringBuilder()
IUser	getUserModel()
final String	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.IWorkflowEventData

getDefaultSystemState, getUser, getWorkflowExecutionPostProcessors

Constructor Details

AWorkflowEventData

@Deprecated
protected AWorkflowEventData(Mandant client,
 IUser user,
 Locale locale)

Deprecated.

Use AWorkflowEventData(Mandant, IUser, Locale, Clock)

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.

AWorkflowEventData

protected AWorkflowEventData(Mandant client,
 IUser user,
 Locale locale,
 Clock clock)

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.

Since:

8.0.0

Method Details

getClient

public Mandant getClient()

Specified by:

getClient in interface IWorkflowEventData

Returns:

The client scope where the event was initiated.

getClock

public Clock getClock()

Specified by:

getClock in interface IWorkflowEventData

Returns:

The clock to use for obtaining the current time.

getLocale

public Locale getLocale()

Specified by:

getLocale in interface IWorkflowEventData

Returns:

The locale to be used for locale-sensitive operations. When not given, the system's or client's default locale is used.

getUserModel

public IUser getUserModel()

Specified by:

getUserModel in interface IWorkflowEventData

Returns:

The user who initiated the event. When not given, an anonymous user is used.

toString

public final String toString()

Overrides:

toString in class Object

getToStringBuilder

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