Interface IStep

  • All Superinterfaces:
    java.io.Serializable
    All Known Implementing Classes:
    Step

    @StableMinor(version="17.0",
                 sinceVersion="7.1")
    public interface IStep
    extends java.io.Serializable
    A interface of process step. This interface provides informations about the step.
    Since:
    7.1.0
    Version:
    $Revision$ $Date$
    • Method Detail

      • isMandatory

        boolean isMandatory()
        Returns whether this step is mandatory.
        Returns:
        whether this step is mandatory.
        Since:
        7.1.0
      • getDescription

        java.lang.String getDescription()
        Returns the description of the step.
        Returns:
        the description of the step.
        Since:
        7.1.0
      • getMessage

        java.lang.String getMessage()
        Returns the message of the step.
        Returns:
        the message of the step.
        Since:
        7.1.0
      • getProcess

        IProcess getProcess()
        Returns the process owner of the step.
        Returns:
        the process owner of the step.
        Since:
        7.1.0
      • getIgnoredDate

        java.util.Date getIgnoredDate()
        Returns the date time that indicates when the step was ignored by user. If the step wasn't ignored, this information will be null.
        Returns:
        the date time that indicates when the step was ignored by user. null if the step wasn't ignored.
        Since:
        7.1.0
      • getIgnoredUserId

        java.lang.String getIgnoredUserId()
        Returns the userId who ignored the step. If the step wasn't ignored, this information will be null.
        Returns:
        the userId who ignored the step. null if the step wasn't ignored.
        Since:
        7.1.0
      • getStepNumber

        int getStepNumber()
        Returns the number of this step.
        Returns:
        the number of this step.
        Since:
        7.1.0