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, ILockingVersionProviding, 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:

  • Field Details

  • Constructor Details

    • WorkflowVersion

      public WorkflowVersion()

  • Method Details

    • 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()
      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:
      The UUID of the entity.

    • 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)
      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 - 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.