Package de.espirit.firstspirit.workflow.model

Interface WorkflowElement

All Known Subinterfaces:
Activity, State, Transition
public interface WorkflowElement
This interface represents an workflow-element from an workflow.
Since:
3.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ACTIVITY
    This workflow-element implements Activity.
    static final String
    PROPERTY_DESCRIPTION
    Name of property to hold this element's description.
    static final String
    PROPERTY_DESCRIPTION_LANGUAGE
    Prefix for properties to hold this element's language dependent description.s
    static final String
    PROPERTY_NAME
    Name of property to hold this element's name.
    static final String
    PROPERTY_NAME_LANGUAGE
    Prefix for properties to hold this element's language dependent names.
    static final int
    STATE
    This workflow-element implements State.
    static final int
    TRANSITION
    This workflow-element implements Transition.

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable String
    getDescription()
    Returns the description from this workflow-element.
    @Nullable String
    getDescription(Language language)
    Returns the language dependant description from this workflow-element.
    @Nullable String
    getDisplayName(Language language)
    Returns the language dependant name from this workflow-element.
    long
    getID()
    Provides the ID of this workflow element.
    Object
    getProperty(String key)
    Returns an property form this workflow-element.
    int
    getType()
    Returns the type of this workflow-element.
    String
    getUid()
    Returns the unique identifier of this workflow-element.
    Workflow
    getWorkflow()
    Returns the workflow this workflow-element belongs to.

  • Field Details

    • PROPERTY_NAME

      static final String PROPERTY_NAME
      Name of property to hold this element's name.
      Since:
      3.0
      See Also:

    • PROPERTY_NAME_LANGUAGE

      static final String PROPERTY_NAME_LANGUAGE
      Prefix for properties to hold this element's language dependent names.
      Since:
      4.2.9
      See Also:

    • PROPERTY_DESCRIPTION

      static final String PROPERTY_DESCRIPTION
      Name of property to hold this element's description.
      Since:
      3.0
      See Also:

    • PROPERTY_DESCRIPTION_LANGUAGE

      static final String PROPERTY_DESCRIPTION_LANGUAGE
      Prefix for properties to hold this element's language dependent description.s
      Since:
      4.2.9
      See Also:

    • ACTIVITY

      static final int ACTIVITY
      This workflow-element implements Activity.
      Since:
      3.0
      See Also:

    • STATE

      static final int STATE
      This workflow-element implements State.
      Since:
      3.0
      See Also:

    • TRANSITION

      static final int TRANSITION
      This workflow-element implements Transition.
      Since:
      3.0
      See Also:

  • Method Details

    • getID

      long getID()
      Provides the ID of this workflow element.
      Returns:
      the unique id for this workflow-element.
      Since:
      3.0

    • getUid

      String getUid()
      Returns the unique identifier of this workflow-element.
      Returns:
      the uid of this TemplateSet
      Since:
      4.2.12

    • getDisplayName

      @Nullable @Nullable String getDisplayName(Language language)
      Returns the language dependant name from this workflow-element.
      Returns:
      the name as a String or null if the language dependant name is not defined
      Since:
      4.2.9

    • getDescription

      @Nullable @Nullable String getDescription()
      Returns the description from this workflow-element.
      Returns:
      the description or null if theres no description.
      Since:
      3.0

    • getDescription

      @Nullable @Nullable String getDescription(Language language)
      Returns the language dependant description from this workflow-element.
      Returns:
      the description or null if theres no language dependant description.
      Since:
      4.2.9

    • getType

      int getType()
      Returns the type of this workflow-element. Its either ACTIVITY), STATE) or TRANSITION).
      Returns:
      the type.
      Since:
      3.0

    • getProperty

      Object getProperty(String key)
      Returns an property form this workflow-element.
      Returns:
      an object that represents this protperty.
      Since:
      3.0

    • getWorkflow

      Workflow getWorkflow()
      Returns the workflow this workflow-element belongs to.
      Returns:
      the workflow.
      Since:
      3.0