org.apache.wiki.workflow
Class Outcome

java.lang.Object
  org.apache.wiki.workflow.Outcome

All Implemented Interfaces:

Serializable

public final class Outcome
extends Object
implements 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

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

boolean	equals(Object obj) Two Outcome objects are equal if their message keys are equal.
static Outcome	forName(String key) Returns a named Outcome.
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.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

STEP_COMPLETE

public static final Outcome STEP_COMPLETE

Complete workflow step (without errors)

STEP_ABORT

public static final Outcome STEP_ABORT

Terminate workflow step (without errors)

STEP_CONTINUE

public static final Outcome STEP_CONTINUE

Continue workflow step (without errors)

DECISION_ACKNOWLEDGE

public static final Outcome DECISION_ACKNOWLEDGE

Acknowlege the Decision.

DECISION_APPROVE

public static final Outcome DECISION_APPROVE

Approve the Decision (and complete the step).

DECISION_DENY

public static final Outcome DECISION_DENY

Deny the Decision (and complete the step).

DECISION_HOLD

public static final Outcome DECISION_HOLD

Put the Decision on hold (and pause the step).

DECISION_REASSIGN

public static final Outcome DECISION_REASSIGN

Reassign the Decision to another actor (and pause the step).

Method Detail

isCompletion

public boolean isCompletion()

Returns true if this Outcome represents a completion condition for a Step.

Returns:

the result

getMessageKey

public 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 Object

Returns:

the hash code

equals

public boolean equals(Object obj)

Two Outcome objects are equal if their message keys are equal.

Overrides:

equals in class Object

Parameters:

obj - the object to test

Returns:

true if logically equal, false if not

forName

public static Outcome forName(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 String toString()

Overrides:

toString in class Object