Package org.apache.wiki.workflow

Class Outcome

java.lang.Object
org.apache.wiki.workflow.Outcome
All Implemented Interfaces:
java.io.Serializable
public final class Outcome
extends java.lang.Object
implements java.io.Serializable
Resolution of a workflow Step, such as "approve," "deny," "hold," "task error," or other potential resolutions.
Since:
2.5
See Also:
Serialized Form

  • Field Summary

    Fields
    Modifier and Type Field Description
    static Outcome DECISION_ACKNOWLEDGE
    Acknowlege the Decision.
    static Outcome DECISION_APPROVE
    Approve the Decision (and complete the step).
    static Outcome DECISION_DENY
    Deny the Decision (and complete the step).
    static Outcome DECISION_HOLD
    Put the Decision on hold (and pause the step).
    static Outcome DECISION_REASSIGN
    Reassign the Decision to another actor (and pause the step).
    static Outcome STEP_ABORT
    Terminate workflow step (without errors)
    static Outcome STEP_COMPLETE
    Complete workflow step (without errors)
    static Outcome STEP_CONTINUE
    Continue workflow step (without errors)

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object obj)
    Two Outcome objects are equal if their message keys are equal.
    static Outcome forName​(java.lang.String key)
    Returns a named Outcome.
    java.lang.String getMessageKey()
    The i18n key for this outcome, which is prefixed by outcome..
    int hashCode()
    The hashcode of an Outcome is identical to the hashcode of its message key, multiplied by 2 if it is a "completion" Outcome.
    boolean isCompletion()
    Returns true if this Outcome represents a completion condition for a Step.
    java.lang.String toString()

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

  • Method Details

    • isCompletion

      public boolean isCompletion()
      Returns true if this Outcome represents a completion condition for a Step.
      Returns:
      the result

    • getMessageKey

      public java.lang.String getMessageKey()
      The i18n key for this outcome, which is prefixed by outcome.. If calling classes wish to return a locale-specific name for this task (such as "approve this request"), they can use this method to obtain the correct key suffix.
      Returns:
      the i18n key for this outcome

    • hashCode

      public int hashCode()
      The hashcode of an Outcome is identical to the hashcode of its message key, multiplied by 2 if it is a "completion" Outcome.
      Overrides:
      hashCode in class java.lang.Object
      Returns:
      the hash code

    • equals

      public boolean equals​(java.lang.Object obj)
      Two Outcome objects are equal if their message keys are equal.
      Overrides:
      equals in class java.lang.Object
      Parameters:
      obj - the object to test
      Returns:
      true if logically equal, false if not

    • forName

      public static Outcome forName​(java.lang.String key) throws NoSuchOutcomeException
      Returns a named Outcome. If an Outcome matching the supplied key is not found, this method throws a NoSuchOutcomeException.
      Parameters:
      key - the name of the outcome
      Returns:
      the Outcome
      Throws:
      NoSuchOutcomeException - if an Outcome matching the key isn't found.

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object