Package de.xima.fc.entities

Class WorkflowVersion

java.lang.Object

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

de.xima.fc.entities.AbstractEntity

de.xima.fc.entities.AbstractLockableEntity

de.xima.fc.entities.WorkflowVersion

All Implemented Interfaces:

de.xima.cmn.dao.interfaces.IEntity<Long>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, IDescriptionProviding, IProjektDependent, ITransferable, ITransferableEntity, ITransferableLockableEntity, IUUIDEntity, IVersionNumberProviding, Serializable, Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>

@Entity
public class WorkflowVersion
extends AbstractLockableEntity
implements IProjektDependent, IDescriptionProviding, IUUIDEntity, IVersionNumberProviding

Represents the version of a project's workflow. Each project may have multiple versions.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_MAIN_PROCESS	JPA attribute name for the getMainProcess() field.
static String	ATTR_MAX_BACKUP_COUNT	JPA attribute name for the getMaxBackupCount() field.
static String	ATTR_STATES	JPA attribute name for the getStates() field.
static String	ATTR_VERSION_NUMBER	JPA attribute name for the getVersionNumber() field.
static String	ATTR_VERSION_WORKFLOW_INVALID	JPA attribute name for the isWorkflowInvalid() field.
static String	COL_DESCRIPTION	Database column name for the getProject() field.
static String	COL_MAX_BACKUP_COUNT	Database column name for the getMaxBackupCount() field.
static String	COL_PROJECT	Database column name for the getProject() field.
static String	COL_VERSION_NUMBER	Database column name for the getVersionNumber() field.
static String	COL_WORKFLOW_INVALID	Database column name for the isWorkflowInvalid() field.
static long	INVALID_VERSION_NUMBER	Version number of that can be used to indicate that no version exists

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, ATTR_DESCRIPTION

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.IProjektDependent

ATTR_PROJEKT

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, TYPE_NAME_UUID

Constructor Summary

Constructors

Constructor	Description
WorkflowVersion()

Method Summary

Modifier and Type	Method	Description
void	addState(WorkflowState state)	Adds the given state to this version, and sets WorkflowState.getVersion() to this version.
WorkflowVersion	cloneBasics()
String	getBeschreibung()	Deprecated. Use getDescription()
String	getDescription()
Long	getId()
WorkflowProcess	getMainProcess()
int	getMaxBackupCount()
Projekt	getProject()
Projekt	getProjekt()	Deprecated. Use getProject().
List<WorkflowState>	getStates()
String	getUUID()
UUID	getUUIDObject()
long	getVersionNumber()
boolean	isWorkflowInvalid()
void	setBeschreibung(String description)	Deprecated. Use setDescription(String).
void	setDescription(String description)
void	setMainProcess(WorkflowProcess mainProcess)
void	setMaxBackupCount(int maxBackupCount)
void	setProject(Projekt project)
void	setProjekt(Projekt projekt)	Deprecated. Use setProject(Projekt).
void	setStates(List<WorkflowState> states)
void	setUUID(String uuid)
void	setUUIDObject(UUID uuid)
void	setVersionNumber(long versionNumber)
void	setWorkflowInvalid(boolean workflowInvalid)

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

entityHasChanged, getLockingVersion, setLockingVersion, toString

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.cmn.dao.interfaces.IEntity

isPersisted, setId

Field Detail

ATTR_MAIN_PROCESS

public static final String ATTR_MAIN_PROCESS

JPA attribute name for the getMainProcess() field.

See Also:

Constant Field Values

ATTR_MAX_BACKUP_COUNT

public static final String ATTR_MAX_BACKUP_COUNT

JPA attribute name for the getMaxBackupCount() field.

See Also:

Constant Field Values

ATTR_STATES

public static final String ATTR_STATES

JPA attribute name for the getStates() field.

See Also:

Constant Field Values

ATTR_VERSION_NUMBER

public static final String ATTR_VERSION_NUMBER

JPA attribute name for the getVersionNumber() field.

See Also:

Constant Field Values

ATTR_VERSION_WORKFLOW_INVALID

public static final String ATTR_VERSION_WORKFLOW_INVALID

JPA attribute name for the isWorkflowInvalid() field.

See Also:

Constant Field Values

COL_DESCRIPTION

public static final String COL_DESCRIPTION

Database column name for the getProject() field.

See Also:

Constant Field Values

COL_MAX_BACKUP_COUNT

public static final String COL_MAX_BACKUP_COUNT

Database column name for the getMaxBackupCount() field.

See Also:

Constant Field Values

COL_PROJECT

public static final String COL_PROJECT

Database column name for the getProject() field.

See Also:

Constant Field Values

COL_VERSION_NUMBER

public static final String COL_VERSION_NUMBER

Database column name for the getVersionNumber() field.

See Also:

Constant Field Values

COL_WORKFLOW_INVALID

public static final String COL_WORKFLOW_INVALID

Database column name for the isWorkflowInvalid() field.

See Also:

Constant Field Values

INVALID_VERSION_NUMBER

public static final long INVALID_VERSION_NUMBER

Version number of that can be used to indicate that no version exists

See Also:

Constant Field Values

Constructor Detail

WorkflowVersion

public WorkflowVersion()

Method Detail

addState

public void addState(WorkflowState state)

Adds the given state to this version, and sets WorkflowState.getVersion() to this version.

Parameters:

state - State to add to this version.

cloneBasics

public WorkflowVersion cloneBasics()

Returns:

A new task instance with all fields that do not reference other entities copied from this instance.

getBeschreibung

@Deprecated
public String getBeschreibung()

Deprecated.

Use getDescription()

Specified by:

getBeschreibung in interface IDescriptionProviding

Returns:

An arbitrary, localized description for this workflow version.

getDescription

public String getDescription()

Specified by:

getDescription in interface IDescriptionProviding

Returns:

An arbitrary, localized description for this workflow version.

getId

public Long getId()

Specified by:

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

getMainProcess

public WorkflowProcess getMainProcess()

Returns:

The main workflow process of the form. This is the process that is started when the form is submitted.

getMaxBackupCount

public int getMaxBackupCount()

Returns:

The maximum number of automatic backups to create for this workflow version. An automatic backup is created when the workflow is saved in the designer.

getProject

public Projekt getProject()

Returns:

The project to which this workflow version belongs.

getProjekt

@Deprecated
public Projekt getProjekt()

Deprecated.

Use getProject().

Specified by:

getProjekt in interface IProjektDependent

Returns:

The project to which this workflow version belongs.

getStates

public List<WorkflowState> getStates()

Returns:

A list of all workflow states that belong to this version. Different workflow version may have different states.

getUUID

public String getUUID()

Specified by:

getUUID in interface IUUIDEntity

Returns:

UUID (Universal Unique Identifier) that identifies this type of entity. Usually is unique within a context, e.g. Mandant, Projekt, ...

getUUIDObject

public UUID getUUIDObject()

Specified by:

getUUIDObject in interface IUUIDEntity

getVersionNumber

public long getVersionNumber()

Specified by:

getVersionNumber in interface IVersionNumberProviding

Returns:

The version number of this workflow version. This is used for sorting the available version of a project.

isWorkflowInvalid

public boolean isWorkflowInvalid()

Returns:

true if the configured workflow is invalid, i.e. had at least one error during validation; or false otherwise.

setBeschreibung

@Deprecated
public void setBeschreibung(String description)

Deprecated.

Use setDescription(String).

Parameters:

description - An arbitrary, localized description for this workflow version.

setDescription

public void setDescription(String description)

Parameters:

description - An arbitrary, localized description for this workflow version.

setMainProcess

public void setMainProcess(WorkflowProcess mainProcess)

Parameters:

mainProcess - The main workflow process that is executed as the workflow of this version. There may be several sub processed that are not executed automatically, but only when requested by the main process.

setMaxBackupCount

public void setMaxBackupCount(int maxBackupCount)

Parameters:

maxBackupCount - The maximum number of automatic backups to create for this workflow version. An automatic backup is created when the workflow is saved in the designer.

setProject

public void setProject(Projekt project)

Parameters:

project - The project to which this workflow version belongs.

setProjekt

@Deprecated
public void setProjekt(Projekt projekt)

Deprecated.

Use setProject(Projekt).

Specified by:

setProjekt in interface IProjektDependent

Parameters:

projekt - The project to which this workflow version belongs.

setStates

public void setStates(List<WorkflowState> states)

Parameters:

states - A list of all workflow states that belong to this version. Different workflow version may have different states.

setUUID

public void setUUID(String uuid)

Specified by:

setUUID in interface IUUIDEntity

setUUIDObject

public void setUUIDObject(UUID uuid)

Parameters:

uuid - The unique UUID for this workflow version. This UUID is unique within the getProject().

setVersionNumber

public void setVersionNumber(long versionNumber)

Parameters:

versionNumber - The version number of this workflow version. This is used for sorting the available version of a project.

setWorkflowInvalid

public void setWorkflowInvalid(boolean workflowInvalid)

Parameters:

workflowInvalid - true if the configured workflow is invalid, i.e. had at least one error during validation; or false otherwise.