Class WorkflowProcess

java.lang.Object
de.xima.cmn.dao.model.AEntity<Long>
de.xima.fc.entities.AbstractEntity
de.xima.fc.entities.AbstractLockableEntity
de.xima.fc.entities.WorkflowProcess
All Implemented Interfaces:
de.xima.cmn.dao.interfaces.IEntity<Long>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, ILockingVersionProviding, ITransferable, ITransferableEntity, ITransferableLockableEntity, IUUIDEntity, Serializable, Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>
@Entity public class WorkflowProcess extends AbstractLockableEntity implements IUUIDEntity
A workflow process that defines which actions are taken when certain events occur during the life cycle of a form record. A workflow process always belong to a WorkflowVersion. Each project may have multiple versions of a workflow process, and one active version.

A process consists of one or more workflow tasks, usually one task for each event (such as submitting the form, or changing the form record's state).

Since:
7.0.0
Author:
XIMA MEDIA GmbH
See Also:

  • Field Details

  • Constructor Details

    • WorkflowProcess

      public WorkflowProcess()

  • Method Details

    • addTask

      public void addTask(WorkflowTask task)
      Adds the given task to this process and sets the WorkflowTask.getProcess() to this process.
      Parameters:
      task - The task to add.

    • getId

      public Long getId()
      Specified by:
      getId in interface de.xima.cmn.dao.interfaces.IEntity<Long>

    • getTasks

      public List<WorkflowTask> getTasks()
      Returns:
      A list of tasks that indicate which actions are executed when certain events occur during the life cycle of a form record.

    • getUUID

      public String getUUID()
      Description copied from interface: IUUIDEntity
      Gets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.
      Specified by:
      getUUID in interface IUUIDEntity
      Returns:
      The UUID of the entity.

    • getUUIDObject

      public UUID getUUIDObject()
      Description copied from interface: IUUIDEntity
      Gets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.
      Specified by:
      getUUIDObject in interface IUUIDEntity
      Returns:
      A unique identifier of this workflow task. This ID must be unique at least among all other processes that belong to the same WorkflowVersion.

    • getVersion

      public WorkflowVersion getVersion()
      Returns:
      The version to which this workflow process belongs, see WorkflowVersion.getMainProcess().

    • setTasks

      public void setTasks(List<WorkflowTask> tasks)
      Parameters:
      tasks - A list of tasks that indicate which actions are executed when certain events occur during the life cycle of a form record.

    • setUUID

      public void setUUID(String uuid)
      Description copied from interface: IUUIDEntity
      Sets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.
      Specified by:
      setUUID in interface IUUIDEntity
      Parameters:
      uuid - The UUID of the entity.

    • setUUIDObject

      public void setUUIDObject(UUID uuid)
      Parameters:
      uuid - A unique identifier of this workflow task. This ID must be unique at least among all other tasks that belong to the same WorkflowProcess.

    • setVersion

      public void setVersion(WorkflowVersion version)
      Parameters:
      version - The version to which this workflow process belongs.

    • cloneBasics

      public WorkflowProcess cloneBasics()
      Returns:
      A new process instance with all fields that do not reference other entities copied from this instance.