Uses of Class
com.ecyrd.jspwiki.workflow.Outcome

Packages that use Outcome
com.ecyrd.jspwiki The chief package of JSPWiki. 
com.ecyrd.jspwiki.auth Authentication, Authorization and the third A thing. 
com.ecyrd.jspwiki.workflow   
 

Uses of Outcome in com.ecyrd.jspwiki
 

Methods in com.ecyrd.jspwiki that return Outcome
 Outcome PageManager.PreSaveWikiPageTask.execute()
          

Executes the processing for this Step and returns an Outcome indicating if it succeeded (STEP_COMPLETE or STEP_ABORT). Processing instructions can do just about anything, such as executing custom business logic or changing the Step's final outcome via Step.setOutcome(Outcome). A return value of STEP_COMPLETE indicates that the instructions executed completely, without errors; STEP_ABORT indicates that the Step and its parent Workflow should be aborted (that is, fail silently without error). If the execution step encounters any errors, it should throw a WikiException or a subclass.

Note that successful execution of this methods does not necessarily mean that the Step is considered "complete"; rather, it just means that it has executed. Therefore, it is possible that execute could run multiple times.

 Outcome PageManager.SaveWikiPageTask.execute()
          

Executes the processing for this Step and returns an Outcome indicating if it succeeded (STEP_COMPLETE or STEP_ABORT). Processing instructions can do just about anything, such as executing custom business logic or changing the Step's final outcome via Step.setOutcome(Outcome). A return value of STEP_COMPLETE indicates that the instructions executed completely, without errors; STEP_ABORT indicates that the Step and its parent Workflow should be aborted (that is, fail silently without error). If the execution step encounters any errors, it should throw a WikiException or a subclass.

Note that successful execution of this methods does not necessarily mean that the Step is considered "complete"; rather, it just means that it has executed. Therefore, it is possible that execute could run multiple times.

 

Uses of Outcome in com.ecyrd.jspwiki.auth
 

Methods in com.ecyrd.jspwiki.auth that return Outcome
 Outcome UserManager.SaveUserProfileTask.execute()
          Saves the user profile to the user database.
 

Uses of Outcome in com.ecyrd.jspwiki.workflow
 

Fields in com.ecyrd.jspwiki.workflow declared as Outcome
static Outcome Outcome.DECISION_ACKNOWLEDGE
          Acknowlege the Decision.
static Outcome Outcome.DECISION_APPROVE
          Approve the Decision (and complete the step).
static Outcome Outcome.DECISION_DENY
          Deny the Decision (and complete the step).
static Outcome Outcome.DECISION_HOLD
          Put the Decision on hold (and pause the step).
static Outcome Outcome.DECISION_REASSIGN
          Reassign the Decision to another actor (and pause the step).
static Outcome Outcome.STEP_ABORT
          Terminate workflow step (without errors)
static Outcome Outcome.STEP_COMPLETE
          Complete workflow step (without errors)
static Outcome Outcome.STEP_CONTINUE
          Continue workflow step (without errors)
 

Methods in com.ecyrd.jspwiki.workflow that return Outcome
 Outcome Step.execute()
           Executes the processing for this Step and returns an Outcome indicating if it succeeded (STEP_COMPLETE or STEP_ABORT).
 Outcome Decision.execute()
          Default implementation that always returns STEP_CONTINUE if the current Outcome isn't a completion (which will be true if the Decision.decide(Outcome) method hasn't been executed yet.
abstract  Outcome AbstractStep.execute()
          

Executes the processing for this Step and returns an Outcome indicating if it succeeded (STEP_COMPLETE or STEP_ABORT).

static Outcome Outcome.forName(String key)
          Returns a named Outcome.
 Outcome Decision.getDefaultOutcome()
          Returns the default or suggested outcome, which must be one of those returned by AbstractStep.getAvailableOutcomes().
 Outcome Step.getOutcome()
          Returns the Outcome of this Step's processing; by default, STEP_CONTINUE.
 Outcome AbstractStep.getOutcome()
          Returns the Outcome of this Step's processing; by default, STEP_CONTINUE.
 

Methods in com.ecyrd.jspwiki.workflow with parameters of type Outcome
 void Step.addSuccessor(Outcome outcome, Step step)
          Adds a successor Step to this one, which will be triggered by a supplied Outcome.
 void AbstractStep.addSuccessor(Outcome outcome, Step step)
          Adds a successor Step to this one, which will be triggered by a supplied Outcome.
 void DecisionQueue.decide(Decision decision, Outcome outcome)
          Attempts to complete a Decision by calling Decision.decide(Outcome).
 void Decision.decide(Outcome outcome)
           Sets this Decision's outcome, and restarts the parent Workflow if it is in the Workflow.WAITING state and this Decision is its currently active Step.
 Step Step.getSuccessor(Outcome outcome)
          Identifies the next Step for a particular Outcome; if there is no next Step for this Outcome, this method returns null.
 Step AbstractStep.getSuccessor(Outcome outcome)
          Identifies the next Step for a particular Outcome; if there is no next Step for this Outcome, this method returns null.
 void Step.setOutcome(Outcome outcome)
          Sets the current Outcome for the step.
 void AbstractStep.setOutcome(Outcome outcome)
          Sets the current Outcome for the step.
 

Constructors in com.ecyrd.jspwiki.workflow with parameters of type Outcome
Decision(Workflow workflow, String messageKey, Principal actor, Outcome defaultOutcome)
          Constructs a new Decision for a required "actor" Principal, having a default Outcome.