|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ecyrd.jspwiki.workflow.AbstractStep
com.ecyrd.jspwiki.workflow.Task
com.ecyrd.jspwiki.PageManager.PreSaveWikiPageTask
public static class PageManager.PreSaveWikiPageTask
Inner class that handles the page pre-save actions. If the proposed page
text is the same as the current version, the execute()
method
returns Outcome.STEP_ABORT
. Any
WikiExceptions thrown by page filters will be re-thrown, and the workflow
will abort.
Constructor Summary | |
---|---|
PageManager.PreSaveWikiPageTask(WikiContext context,
String proposedText)
Creates the task. |
Method Summary | |
---|---|
Outcome |
execute()
Executes the processing for this Step and returns an Outcome indicating
if it succeeded (
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 |
Methods inherited from class com.ecyrd.jspwiki.workflow.Task |
---|
getActor, getSuccessor, setSuccessor |
Methods inherited from class com.ecyrd.jspwiki.workflow.AbstractStep |
---|
addError, addSuccessor, getAvailableOutcomes, getEndTime, getErrors, getMessageArguments, getMessageKey, getOutcome, getOwner, getStartTime, getSuccessor, getWorkflow, isCompleted, isStarted, setOutcome, setWorkflow, start |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PageManager.PreSaveWikiPageTask(WikiContext context, String proposedText)
context
- The WikiContextproposedText
- The text that was just saved.Method Detail |
---|
public Outcome execute() throws WikiException
Executes the processing for this Step and returns an Outcome indicating
if it succeeded (Outcome.STEP_COMPLETE
or
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_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.
execute
in interface Step
execute
in class AbstractStep
WikiException
- if the step encounters errors while executing
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |