Interface State

All Superinterfaces:
WorkflowElement

public interface State extends WorkflowElement
This interface represents an state in an workflow-model.
Since:
3.0
  • Field Details

    • PROPERTY_VALUE_AUTOMATIC_EDITOR

      static final int PROPERTY_VALUE_AUTOMATIC_EDITOR
      Mode for automatic editor selection.
      Since:
      3.0.7
      See Also:
    • PROPERTY_VALUE_MANUAL_EDITOR

      static final int PROPERTY_VALUE_MANUAL_EDITOR
      Mode for manual editor selection.
      Since:
      3.0.7
      See Also:
    • PROPERTY_LOCK_STOREELEMENT

      static final String PROPERTY_LOCK_STOREELEMENT
      Name of property for write protection.
      Since:
      3.0.4
      See Also:
    • PROPERTY_EDITOR_MODE

      static final String PROPERTY_EDITOR_MODE
      Name of property for editor mode.
      Since:
      3.0.4
      See Also:
    • PROPERTY_RELEASE

      static final String PROPERTY_RELEASE
      Name of property for operating on release store.
      Since:
      3.0
      See Also:
    • PROPERTY_COLOR

      static final String PROPERTY_COLOR
      Name of property for defining the workflow state color.
      Since:
      3.0
      See Also:
    • PROPERTY_DURATION

      static final String PROPERTY_DURATION
      Name of property for duration.
      Since:
      3.0
      See Also:
    • PROPERTY_USER

      static final String PROPERTY_USER
      Name of property defining the responsible users.
      Since:
      3.0
      See Also:
    • PROPERTY_GROUPS

      static final String PROPERTY_GROUPS
      Name of property defining the responsible groups.
      Since:
      3.0
      See Also:
    • PROPERTY_LOCATION

      static final String PROPERTY_LOCATION
      Name of property for location.
      Since:
      3.0
      See Also:
  • Method Details

    • getSourceTransitions

      List<? extends Transition> getSourceTransitions()
      Returns all transitions that points TO this state.
      Returns:
      an list with all transitions or an empty list if there is no transition.
      Since:
      3.0
    • getTargetTransitions

      List<? extends Transition> getTargetTransitions()
      Returns all Transitions which points FROM this state.
      Returns:
      an list with all transitions or an empty list if there is no transitions.
      Since:
      3.0
    • getColor

      Color getColor()
      Returns the color that represents this state in the tree-model.
      Returns:
      the color.
      Since:
      3.0
    • getDuration

      long getDuration()
      Returns the maximum retention period for this state.
      Returns:
      the duration or null if there no maximum retention period.
      Since:
      3.0
    • getResponsibleUser

      List<String> getResponsibleUser()
      Returns the user (login names) who are responsible for this state.
      Since:
      3.0
    • getResponsibleGroups

      List<String> getResponsibleGroups()
      Returns the groups (names) who are responsible for this state.
      Since:
      3.0
    • isStartState

      boolean isStartState()
      Returns true if this state is an start-state; false otherwise.
      Since:
      3.0
    • isEndState

      boolean isEndState()
      Returns true if this state is an end-state; false otherwise.
      Since:
      3.0
    • isErrorState

      boolean isErrorState()
      Returns true if this state is an error-state; false otherwise.
      Since:
      4.0.120
    • releaseStoreElement

      boolean releaseStoreElement()
      Returns true if end-state and the store-element will be released when reached this state.
      Since:
      3.0
    • getEditorMode

      int getEditorMode()
      Return the mode of the permission checking
      Since:
      3.0.4
    • getStoreElementLock

      boolean getStoreElementLock()
      Get StoreElement writelock
      Since:
      3.0.4