# Uses of Interface
org.apache.wiki.workflow.Step

Packages that use Step
Package
Description
org.apache.wiki.tasks
Provides specific tasks for JSPWiki, meant to be executed by the workflow framework.
org.apache.wiki.tasks.auth
Provides auth-related Tasks, meant to be executed by the workflow framework.
org.apache.wiki.tasks.pages
Provides WikiPages' saving related Tasks, meant to be executed by the workflow framework.
org.apache.wiki.workflow

## Uses of Step in org.apache.wiki.tasks

Methods in org.apache.wiki.tasks that return Step
Modifier and Type
Method
Description
`Step`
DefaultTasksManager.`buildPreSaveWikiPageTask(String proposedText)`
Builds a pre-save WikiPage task.
`Step`
TasksManager.`buildPreSaveWikiPageTask(String proposedText)`
Builds a pre-save WikiPage task.
`Step`
DefaultTasksManager.`buildSaveUserProfileTask(Locale loc)`
Builds a save user profile task.
`Step`
TasksManager.`buildSaveUserProfileTask(Locale loc)`
Builds a save user profile task.
`Step`
DefaultTasksManager.`buildSaveWikiPageTask()`
Builds a save WikiPage task.
`Step`
TasksManager.`buildSaveWikiPageTask()`
Builds a save WikiPage task.

## Uses of Step in org.apache.wiki.tasks.auth

Classes in org.apache.wiki.tasks.auth that implement Step
Modifier and Type
Class
Description
`class`
`SaveUserProfileTask`
Handles the actual profile save action.

## Uses of Step in org.apache.wiki.tasks.pages

Classes in org.apache.wiki.tasks.pages that implement Step
Modifier and Type
Class
Description
`class`
`PreSaveWikiPageTask`
Handles the page pre-save actions.
`class`
`SaveWikiPageTask`
Handles the actual page save and post-save actions.

## Uses of Step in org.apache.wiki.workflow

Classes in org.apache.wiki.workflow that implement Step
Modifier and Type
Class
Description
`class`
`AbstractStep`
Abstract superclass that provides a complete implementation of most Step methods; subclasses need only implement `AbstractStep.execute(Context)` and `AbstractStep.getActor()`.
`class`
`Decision`
AbstractStep subclass that asks an actor Principal to choose an Outcome on behalf of an owner (also a Principal).
`class`
`SimpleDecision`
Decision subclass that includes two available Outcomes: `Outcome.DECISION_APPROVE` or `Outcome.DECISION_DENY`.
`final class`
`SimpleNotification`
Decision subclass used for notifications that includes only one available Outcome: `Outcome.DECISION_ACKNOWLEDGE`.
`class`
`Task`
AbstractStep subclass that executes instructions, uninterrupted, and results in an Outcome.
Methods in org.apache.wiki.workflow that return Step
Modifier and Type
Method
Description
`final Step`
Workflow.`getCurrentStep()`
Returns the current Step, or `null` if the workflow has not started or already completed.
`final Step`
Workflow.`getPreviousStep()`
Convenience method that returns the predecessor of the current Step.
`final 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`.
`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`.
`final Step`
Task.`getSuccessor()`
Identifies the next Step after this Task finishes successfully.
`protected final Step`
Workflow.`previousStep(Step step)`
Protected method that returns the predecessor for a supplied Step.
Methods in org.apache.wiki.workflow that return types with arguments of type Step
Modifier and Type
Method
Description
`final List<Step>`
Workflow.`getHistory()`
Returns a Step history for this Workflow as a List, chronologically, from the first Step to the currently executing one.
Methods in org.apache.wiki.workflow with parameters of type Step
Modifier and Type
Method
Description
`final void`
AbstractStep.`addSuccessor(Outcome outcome, Step step)`
Adds a successor Step to this one, which will be triggered by a supplied Outcome.
`void`
Step.`addSuccessor(Outcome outcome, Step step)`
Adds a successor Step to this one, which will be triggered by a supplied Outcome.
`Workflow`
WorkflowBuilder.`buildApprovalWorkflow(Principal submitter, String workflowApproverKey, Step prepTask, String decisionKey, Fact[] facts, Step completionTask, String rejectedMessageKey)`
Builds an approval workflow that requests approval from a named user, `Group` or `Role` before running a Task.
`protected final Step`
Workflow.`previousStep(Step step)`
Protected method that returns the predecessor for a supplied Step.
`final void`
Workflow.`setFirstStep(Step step)`
Sets the first Step for this Workflow, which will be executed immediately after the `Workflow.start(Context)` method executes.
`final void`
Task.`setSuccessor(Step step)`
Sets the successor Step to this one, which will be triggered if the Task completes successfully (that is, `getOutcome()` returns `Outcome.STEP_COMPLETE`.