Package de.xima.fc.entities

Class WorkflowTrigger

java.lang.Object

de.xima.cmn.dao.model.AEntity<Long>

de.xima.fc.entities.AbstractEntity

de.xima.fc.entities.AbstractLockableEntity

de.xima.fc.entities.AWorkflowElement<WorkflowTrigger,WorkflowTriggerSearchTerm>

de.xima.fc.entities.WorkflowTrigger

All Implemented Interfaces:

de.xima.cmn.dao.interfaces.IEntity<Long>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, IDescriptionProviding, ILockingVersionProviding, INameProviding, ITransferable, ITransferableEntity, ITransferableLockableEntity, IUUIDEntity, IActiveFlagProviding, ICustomParametersProviding, IElementKeyProviding, IElementSearchTermsProviding, IIdProviding<Long>, ITriggerKeyProviding, IUuidProviding, IVersionedCustomParametersProviding, IWorkflowElementEntity, IWorkflowElementTypeProviding, IWorkflowTriggerTypeProviding, Serializable, Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>

@Entity
public class WorkflowTrigger
extends AWorkflowElement<WorkflowTrigger,WorkflowTriggerSearchTerm>
implements IWorkflowTriggerTypeProviding, ITriggerKeyProviding

A workflow trigger that start a WorkflowTask when a certain event occurs.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields inherited from class de.xima.fc.entities.AWorkflowElement

active, ATTR_ACTIVE, ATTR_CUSTOM_PARAMETERS, ATTR_CUSTOM_PARAMETERS_VERSION, ATTR_DESCRIPTION, ATTR_SEARCH_TERMS, ATTR_TASK, ATTR_TYPE, COL_ACTIVE, COL_CUSTOM_PARAMETERS, COL_CUSTOM_PARAMETERS_VERSION, COL_DESCRIPTION, COL_NAME, COL_TASK, COL_TYPE, customParameters, customParametersVersion, description, name, searchTerms, task, type, uuid

Fields inherited from class de.xima.fc.entities.AbstractLockableEntity

COL_LOCKINGVERSION, lockingVersion

Fields inherited from class de.xima.fc.entities.AbstractEntity

COL_ID, id

Fields inherited from interface de.xima.fc.entities.interfaces.IDescriptionProviding

ATTR_BESCHREIBUNG

Fields inherited from interface de.xima.cmn.dao.interfaces.IEntity

ATTR_ID

Fields inherited from interface de.xima.cmn.dao.interfaces.ILockableEntity

ATTR_LOCKINGVERSION

Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding

ATTR_NAME

Fields inherited from interface de.xima.fc.entities.interfaces.ITransferableEntity

IMPORT_ID, INVALID_ID

Fields inherited from interface de.xima.fc.entities.interfaces.IUUIDEntity

ATTR_UUID, COL_UUID, INVALID_UUID, INVALID_UUID_OBJECT, NULL_SAFE_UUID_TYPE, NULLABLE_UUID_TYPE, TYPE_NAME_UUID

Constructor Summary

Constructors

Constructor	Description
WorkflowTrigger()

Method Summary

Modifier and Type	Method	Description
String	getDisplayName(Locale locale)	Returns the display name of this workflow trigger for the given locale.
Long	getId()
ElementKey	getKey()
List<WorkflowTriggerSearchTerm>	getSearchTerms()
TriggerKey	getTriggerKey()
void	putSearchTerm(WorkflowTriggerSearchTerm searchTerm)	Adds the given search term to this element, and sets AWorkflowElementSearchTerm.getElement() to this element.
String	toString()

Methods inherited from class de.xima.fc.entities.AWorkflowElement

cloneBasics, getBeschreibung, getCustomParameters, getCustomParametersVersion, getDescription, getName, getTask, getType, getUuid, getUUID, getUUIDObject, isActive, setActive, setCustomParameters, setCustomParametersVersion, setDescription, setName, setSearchTerms, setTask, setType, setUUID, setUUIDObject

Methods inherited from class de.xima.fc.entities.AbstractLockableEntity

entityHasChanged, getLockingVersion, setLockingVersion

Methods inherited from class de.xima.fc.entities.AbstractEntity

asIntValue, isPersisted, setId, setId

Methods inherited from class de.xima.cmn.dao.model.AEntity

compareTo, equals, getDBTableName, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface de.xima.fc.interfaces.workflow.ICustomParametersProviding

getCustomParametersJson

Methods inherited from interface de.xima.cmn.dao.interfaces.IEntity

isPersisted, setId

Methods inherited from interface de.xima.fc.interfaces.workflow.IWorkflowElementEntity

setCustomParametersJson

Methods inherited from interface de.xima.fc.interfaces.workflow.IWorkflowElementTypeProviding

getType

Constructor Detail

WorkflowTrigger

public WorkflowTrigger()

Method Detail

getId

public Long getId()

Specified by:

getId in interface de.xima.cmn.dao.interfaces.IEntity<Long>

Specified by:

getId in interface IIdProviding<Long>

Returns:

The ID that identifies this instance.

getKey

public ElementKey getKey()

Specified by:

getKey in interface IElementKeyProviding

Returns:

The key that identifies this instance.

getSearchTerms

public List<WorkflowTriggerSearchTerm> getSearchTerms()

Specified by:

getSearchTerms in interface IElementSearchTermsProviding

Returns:

The search terms that were defined for this workflow element.

getTriggerKey

public TriggerKey getTriggerKey()

Specified by:

getTriggerKey in interface ITriggerKeyProviding

Returns:

The trigger key that identifies this instance.

putSearchTerm

public void putSearchTerm(WorkflowTriggerSearchTerm searchTerm)

Adds the given search term to this element, and sets AWorkflowElementSearchTerm.getElement() to this element.

Parameters:

searchTerm - The search term to add to this element.

getDisplayName

public String getDisplayName(Locale locale)

Returns the display name of this workflow trigger for the given locale. If no localization is found for the given locale, the default name of the trigger is returned.

Parameters:

locale - the locale for which to return the display name. If null, the first available localization is returned, or the default name if no localizations are available.

Returns:

the display name of this workflow trigger for the given locale, or the default name if no localization is found.

toString

public String toString()

Overrides:

toString in class AbstractLockableEntity