Package ch.ivyteam.ivy.workflow

Enum Class CaseState

java.lang.Object
java.lang.Enum<CaseState>
ch.ivyteam.ivy.workflow.CaseState
All Implemented Interfaces:
ch.ivyteam.ivy.persistence.IPersistentEnumeration, Serializable, Comparable<CaseState>, java.lang.constant.Constable
public enum CaseState extends Enum<CaseState> implements ch.ivyteam.ivy.persistence.IPersistentEnumeration
The state of the case
Since:
17.05.2006
API:
This is a public API.

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CREATED
    Created means the Case has bean started and is currently in progress in its first Task.
    DESTROYED
    Destroyed means somebody destroyed the case, in order to stop any work on it.
    DONE
    Done means all Tasks of the Case are done.
    RUNNING
    Running means the Case is in progress.
    ZOMBIE
    Deprecated, for removal: This API element is subject to removal in a future version.
    not used anymore.

  • Method Summary

    Modifier and Type
    Method
    Description
    CaseBusinessState
    getBusinessState()
    Returns the business state of this state.

  • Enum Constant Details

    • CREATED

      public static final CaseState CREATED

      Created means the Case has bean started and is currently in progress in its first Task. When the first task is finished, it becomes either RUNNING if it has other Tasks or DONE if it had only this one Task. If the user does not finish the first Task (eg. Session Timeout) the Case becomes a ZOMBIE

      Database Value: 0

      API:
      This public API is available in Java.

    • RUNNING

      public static final CaseState RUNNING

      Running means the Case is in progress. The Case has at least one Task which is not yet finished.

      Database Value: 1

      API:
      This public API is available in Java.

    • DONE

      public static final CaseState DONE

      Done means all Tasks of the Case are done. There is no work left for this case.

      Database Value: 2

      API:
      This public API is available in Java.

    • DESTROYED

      public static final CaseState DESTROYED

      Destroyed means somebody destroyed the case, in order to stop any work on it. A Case can be destroyed by calling the ICase.destroy() method, or by destroying all running tasks of the Case.

      Database Value: 3

      API:
      This public API is available in Java.

    • ZOMBIE

      @Deprecated(since="11.1", forRemoval=true) public static final CaseState ZOMBIE
      Deprecated, for removal: This API element is subject to removal in a future version.
      not used anymore. cases which become zombies will be deleted.
      API:
      This public API is available in Java.

  • Method Details

    • getBusinessState

      public CaseBusinessState getBusinessState()
      Returns the business state of this state.
      Returns:
      business state.
      API:
      This public API is available in Java.