Package de.espirit.firstspirit.workflow.model

Interface Transition

All Superinterfaces:
WorkflowElement
public interface Transition extends WorkflowElement
This interface represents a transition in the workflow-model.
Since:
3.0

  • Field Details

    • TASK_RIGHT_CREATOR

      static final int TASK_RIGHT_CREATOR
      Value when defining rights for creator.
      Since:
      3.0.4
      See Also:

    • TASK_RIGHT_LAST_USER

      static final int TASK_RIGHT_LAST_USER
      Value when defining rights for the last user.
      Since:
      3.0.4
      See Also:

    • TASK_RIGHT_LAST_ACTION_USER

      static final int TASK_RIGHT_LAST_ACTION_USER
      Value when defining rights for the last action user.
      Since:
      3.0.4
      See Also:

    • TASK_RIGHTS

      static final int[] TASK_RIGHTS
      Combined right definition for all of the above.
      Since:
      3.0.4

    • PROPERTY_FIXED_RIGHTS

      static final String PROPERTY_FIXED_RIGHTS
      Name of property to use fixed rights.
      Since:
      3.0.4
      See Also:

    • PROPERTY_STOREELEMENT_RIGHTS

      static final String PROPERTY_STOREELEMENT_RIGHTS
      Name of property to use store element rights.
      Since:
      3.0.4
      See Also:

    • PROPERTY_TASK_RIGHTS

      static final String PROPERTY_TASK_RIGHTS
      Name of property to use task rights.
      Since:
      3.0.4
      See Also:

    • PROPERTY_USED_STOREELEMENT_RIGHT

      static final String PROPERTY_USED_STOREELEMENT_RIGHT
      Name of property of the used store element rights.
      Since:
      3.0.4
      See Also:

    • PROPERTY_USED_TASK_RIGHTS

      static final String PROPERTY_USED_TASK_RIGHTS
      Name of property of the used task rights.
      Since:
      3.0.4
      See Also:

    • PROPERTY_USER

      static final String PROPERTY_USER
      Name of property of users permitted.
      Since:
      3.0
      See Also:

    • PROPERTY_GROUPS

      static final String PROPERTY_GROUPS
      Name of property of groups permitted.
      Since:
      3.0
      See Also:

    • PROPERTY_NO_EDITOR_GROUPS

      static final String PROPERTY_NO_EDITOR_GROUPS
      Name of property of exclued groups.
      Since:
      3.0.79
      See Also:

    • PROPERTY_POINTS

      static final String PROPERTY_POINTS
      Name of property holding the graphical position of the transition representation.
      Since:
      3.0
      See Also:

    • PROPERTY_LABEL_POS

      static final String PROPERTY_LABEL_POS
      Name of property holding the graphical position of the transition label.
      Since:
      3.1.175
      See Also:

    • PROPERTY_PORT_SOURCE

      static final String PROPERTY_PORT_SOURCE
      Property value identifying a port as source.
      Since:
      3.0
      See Also:

    • PROPERTY_PORT_TARGET

      static final String PROPERTY_PORT_TARGET
      Property value identifying a port as target.
      Since:
      3.0
      See Also:

    • PROPERTY_VALUE_NO_PORT

      static final int PROPERTY_VALUE_NO_PORT
      Property value on not having a port.
      Since:
      3.0
      See Also:

    • PROPERTY_VALUE_WEST_PORT

      static final int PROPERTY_VALUE_WEST_PORT
      Property value on having a west port.
      Since:
      3.0
      See Also:

    • PROPERTY_VALUE_EAST_PORT

      static final int PROPERTY_VALUE_EAST_PORT
      Property value on having an east port.
      Since:
      3.0
      See Also:

    • PROPERTY_VALUE_NORTH_PORT

      static final int PROPERTY_VALUE_NORTH_PORT
      Property value on having a north port.
      Since:
      3.0
      See Also:

    • PROPERTY_VALUE_SOUTH_PORT

      static final int PROPERTY_VALUE_SOUTH_PORT
      Property value on having a south port.
      Since:
      3.0
      See Also:

    • PROPERTY_EMAIL_SEND

      static final String PROPERTY_EMAIL_SEND
      Name of e-mail activation property.
      Since:
      3.0.4
      See Also:

    • PROPERTY_EMAIL_BENEFICIARY

      static final String PROPERTY_EMAIL_BENEFICIARY
      Name of activation property to send e-mails to beneficiaries.
      Since:
      3.0.4
      See Also:

    • PROPERTY_EMAIL_TASK_CREATOR

      static final String PROPERTY_EMAIL_TASK_CREATOR
      Name of activation property to send e-mails to task creators.
      Since:
      3.0.4
      See Also:

    • PROPERTY_EMAIL_EDITORS

      static final String PROPERTY_EMAIL_EDITORS
      Name of activation property to send e-mails to editors.
      Since:
      3.0.4
      See Also:

    • PROPERTY_EMAIL_LAST_AGENT

      static final String PROPERTY_EMAIL_LAST_AGENT
      Name of activation property to send e-mails to the last editor.
      Since:
      3.0.4
      See Also:

    • PROPERTY_EMAIL_LIST

      static final String PROPERTY_EMAIL_LIST
      Name of activation property to send e-mails to a list of e-mail receivers.
      Since:
      3.0.4
      See Also:

    • PROPERTY_EMAIL_SUBJECT

      static final String PROPERTY_EMAIL_SUBJECT
      Name of e-mail subject property.
      Since:
      3.0.4
      See Also:

    • PROPERTY_EMAIL_BODY

      static final String PROPERTY_EMAIL_BODY
      Name of e-mail body property.
      Since:
      3.0.4
      See Also:

    • PROPERTY_EMAIL_USER

      static final String PROPERTY_EMAIL_USER
      Name of property defining a list of e-mail receivers by user names.
      Since:
      3.0.4
      See Also:

    • PROPERTY_EMAIL_GROUPS

      static final String PROPERTY_EMAIL_GROUPS
      Name of property defining a list of e-mail receivers by group names.
      Since:
      3.0.6
      See Also:

    • PROPERTY_POSITION

      static final String PROPERTY_POSITION
      Position of ViewOrder.
      Since:
      5.2.200406
      See Also:

    • EMAIL_SEND

      static final int EMAIL_SEND
      E-mail property bit value on whether to send e-mails.
      Since:
      3.0.4
      See Also:

    • EMAIL_ALLOWED

      static final int EMAIL_ALLOWED
      E-mail property bit value on whether to send to beneficiaries.
      Since:
      3.0.6
      See Also:

    • EMAIL_TASK_CREATOR

      static final int EMAIL_TASK_CREATOR
      E-mail property bit value on whether to send to the task creator.
      Since:
      3.0.4
      See Also:

    • EMAIL_LAST_AGENT

      static final int EMAIL_LAST_AGENT
      E-mail property bit value on whether to send to the last editor.
      Since:
      3.0.4
      See Also:

    • EMAIL_LIST

      static final int EMAIL_LIST
      E-mail property bit value on whether to send to a list.
      Since:
      3.0.4
      See Also:

    • EMAIL_EDITORS

      static final int EMAIL_EDITORS
      E-mail property bit value on whether to send to editors.
      Since:
      3.0.4
      See Also:

  • Method Details

    • getSource

      @Nullable @Nullable WorkflowElement getSource()
      Returns the workflow-element this transitions points FROM.
      Returns:
      an workflow-element that implements either State or Activity.
      Since:
      3.0

    • getTarget

      @Nullable @Nullable WorkflowElement getTarget()
      Returns the workflow-element this transitions points TO.
      Returns:
      an workflow-element that implements either State or Activity.
      Since:
      3.0

    • getAllowedUsers

      List<String> getAllowedUsers()
      Returns all user that are allowed to do this transition.
      Returns:
      a list that contains unique user names.
      Since:
      3.0

    • getAllowedGroups

      List<String> getAllowedGroups()
      Returns all groups that are allowed to do this transition.
      Returns:
      a list that contains unique group names.
      Since:
      3.0

    • getNoEditorGroups

      List<String> getNoEditorGroups()
      Groups marked as no editor are not preselected as editor.
      Returns:
      List of groups
      Since:
      3.0.79

    • getEmailProperty

      boolean getEmailProperty(int property)
      Returns true if this activity has the given property
      Parameters:
      property - one of the email properties defined by this interface
      Returns:
      true if the given property is correct
      Since:
      3.0.4

    • getEmailSubject

      String getEmailSubject()
      Returns the title from the email. Is only valid with email-send property.
      Returns:
      the title as a string
      Since:
      3.0.4

    • getEmailBody

      String getEmailBody()
      Returns the text from the email. Is only valid with email-send property.
      Returns:
      the text as a string
      Since:
      3.0.4

    • getEmailUser

      List<String> getEmailUser()
      Returns the user who are selected to be notiefied by mail. Only valid with email-list property.
      Returns:
      a list with the selected users
      Since:
      3.0.4

    • getEmailGroups

      List<String> getEmailGroups()
      Provides the groups to e-mail to.
      Returns:
      A list of names.
      Since:
      3.0.6

    • useFixedRights

      boolean useFixedRights()
      Indicates whether to use fixed rights.
      Returns:
      true, if to use fixed rights.
      Since:
      3.0.4

    • useStoreElementRights

      boolean useStoreElementRights()
      Indicates whether to use store element rights.
      Returns:
      true, if to use store element rights.
      Since:
      3.0.4

    • getUsedStoreElementRights

      int getUsedStoreElementRights()
      Provides the store element rights to use.
      Returns:
      A store element rights code.
      Since:
      3.0.4

    • useTaskRights

      boolean useTaskRights()
      Indicates whether to use task rights.
      Returns:
      true, if to use task rights.
      Since:
      3.0.4

    • getUsedTaskRights

      int getUsedTaskRights()
      Provides the task rights to use.
      Returns:
      A task rights code.
      Since:
      3.0.4

    • getPosition

      int getPosition()
      Provides the position of a Transition
      Returns:
      position
      Since:
      5.2.200406