Class PreSaveWikiPageTask

    • Constructor Detail

      • PreSaveWikiPageTask

        public PreSaveWikiPageTask​(java.lang.String proposedText)
        Creates the task.
        Parameters:
        proposedText - The text that was just saved.
    • 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 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.

        Specified by:
        execute in interface Step
        Specified by:
        execute in class AbstractStep
        Parameters:
        context - executing wiki context.
        Returns:
        the result of the Step, expressed as an Outcome
        Throws:
        WikiException - if the step encounters errors while executing