- All Implemented Interfaces:
public class PreSaveWikiPageTask extends TaskHandles the page pre-save actions. If the proposed page text is the same as the current version, the
execute( Context )method returns
Outcome.STEP_ABORT. Any WikiExceptions thrown by page filters will be re-thrown, and the workflow will abort.
- See Also:
- Serialized Form
Constructors Constructor Description
PreSaveWikiPageTask(java.lang.String proposedText)Creates the task.
All Methods Instance Methods Concrete Methods Modifier and Type Method Description
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
public PreSaveWikiPageTask(java.lang.String proposedText)Creates the task.
proposedText- The text that was just saved.
public Outcome execute(Context context) throws WikiException
Executes the processing for this Step and returns an Outcome indicating if it succeeded (
Outcome.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_COMPLETEindicates that the instructions executed completely, without errors;
STEP_ABORTindicates 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
executecould run multiple times.