Class SaveWikiPageTask
- java.lang.Object
-
- org.apache.wiki.workflow.AbstractStep
-
- org.apache.wiki.workflow.Task
-
- org.apache.wiki.tasks.pages.SaveWikiPageTask
-
- All Implemented Interfaces:
java.io.Serializable
,Step
public class SaveWikiPageTask extends Task
Handles the actual page save and post-save actions.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from interface org.apache.wiki.workflow.Step
TIME_NOT_SET
-
-
Constructor Summary
Constructors Constructor Description SaveWikiPageTask()
Creates the Task.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Outcome
execute(Context context)
Executes the processing for this Step and returns an Outcome indicating if it succeeded (Outcome.STEP_COMPLETE
orOutcome.STEP_ABORT
).-
Methods inherited from class org.apache.wiki.workflow.Task
getActor, getSuccessor, setSuccessor
-
Methods inherited from class org.apache.wiki.workflow.AbstractStep
addError, addSuccessor, getAvailableOutcomes, getEndTime, getErrors, getMessageKey, getOutcome, getStartTime, getSuccessor, getWorkflowContext, getWorkflowId, isCompleted, isStarted, setOutcome, setWorkflow, start
-
-
-
-
Constructor Detail
-
SaveWikiPageTask
public SaveWikiPageTask()
Creates the Task.
-
-
Method Detail
-
execute
public Outcome execute(Context context) throws WikiException
Executes the processing for this Step and returns an Outcome indicating if it succeeded (
Outcome.STEP_COMPLETE
orOutcome.STEP_ABORT
). Processing instructions can do just about anything, such as executing custom business logic or changing the Step's final outcome viaStep.setOutcome(Outcome)
. A return value ofSTEP_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.- Specified by:
execute
in interfaceStep
- Specified by:
execute
in classAbstractStep
- Parameters:
context
- executing wiki context.- Returns:
- the result of the Step, expressed as an Outcome
- Throws:
WikiException
- if the step encounters errors while executing
-
-