|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.wiki.workflow.DecisionQueue
public class DecisionQueue
Keeps a queue of pending Decisions that need to be acted on by named Principals.
Constructor Summary | |
---|---|
DecisionQueue()
Constructs a new DecisionQueue. |
Method Summary | |
---|---|
protected void |
add(Decision decision)
Adds a Decision to the DecisionQueue; also sets the Decision's unique identifier. |
void |
decide(Decision decision,
Outcome outcome)
Attempts to complete a Decision by calling Decision.decide(Outcome) . |
protected Decision[] |
decisions()
Protected method that returns all pending Decisions in the queue, in order of submission. |
Collection |
getActorDecisions(WikiSession session)
Returns a Collection representing the current Decisions that pertain to a users's WikiSession. |
void |
reassign(Decision decision,
Principal owner)
Reassigns the owner of the Decision to a new owner. |
protected void |
remove(Decision decision)
Protected method that removes a Decision from the queue. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DecisionQueue()
Method Detail |
---|
protected void add(Decision decision)
decision
- the Decision to addprotected Decision[] decisions()
protected void remove(Decision decision)
decision
- the decision to removepublic Collection getActorDecisions(WikiSession session)
Decision.getActor()
value match. If the wiki session is not
authenticated, this method returns an empty Collection.
session
- the wiki session
public void decide(Decision decision, Outcome outcome) throws WikiException
Decision.decide(Outcome)
. This will cause the Step immediately
following the Decision (if any) to start. If the decision completes
successfully, this method also removes the completed decision from the
queue.
decision
- the Decision for which the Outcome will be suppliedoutcome
- the Outcome of the Decision
WikiException
- if the succeeding Step cannot start
for any reasonpublic void reassign(Decision decision, Principal owner) throws WikiException
Decision.reassign(Principal)
.
decision
- the Decision to reassignowner
- the new owner
WikiException
- never
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |