| java.lang.Object com.ecyrd.jspwiki.workflow.Outcome
Outcome | final public class Outcome (Code) | | Resolution of a workflow Step, such as "approve," "deny," "hold," "task
error," or other potential resolutions.
author: Andrew Jaquith since: 2.5 |
Method Summary | |
public boolean | equals(Object obj) Two Outcome objects are equal if their message keys are equal. | public static Outcome | forName(String key) Returns a named Outcome. | public String | getMessageKey() The i18n key for this outcome, which is prefixed by outcome. . | 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. | public boolean | isCompletion() Returns true if this Outcome represents a completion
condition for a Step. | public String | toString() |
DECISION_ACKNOWLEDGE | final public static Outcome DECISION_ACKNOWLEDGE(Code) | | Acknowlege the Decision.
|
DECISION_APPROVE | final public static Outcome DECISION_APPROVE(Code) | | Approve the Decision (and complete the step).
|
DECISION_DENY | final public static Outcome DECISION_DENY(Code) | | Deny the Decision (and complete the step).
|
DECISION_HOLD | final public static Outcome DECISION_HOLD(Code) | | Put the Decision on hold (and pause the step).
|
DECISION_REASSIGN | final public static Outcome DECISION_REASSIGN(Code) | | Reassign the Decision to another actor (and pause the step).
|
STEP_ABORT | final public static Outcome STEP_ABORT(Code) | | Terminate workflow step (without errors)
|
STEP_COMPLETE | final public static Outcome STEP_COMPLETE(Code) | | Complete workflow step (without errors)
|
STEP_CONTINUE | final public static Outcome STEP_CONTINUE(Code) | | Continue workflow step (without errors)
|
equals | public boolean equals(Object obj)(Code) | | Two Outcome objects are equal if their message keys are equal.
Parameters: obj - the object to test true if logically equal, false if not |
getMessageKey | public String getMessageKey()(Code) | | 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.
the i18n key for this outcome |
hashCode | public int hashCode()(Code) | | The hashcode of an Outcome is identical to the hashcode of its message
key, multiplied by 2 if it is a "completion" Outcome.
the hash code |
isCompletion | public boolean isCompletion()(Code) | | Returns true if this Outcome represents a completion
condition for a Step.
the result |
|
|