ExampleWorkflowDefinition

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. def act(step: ExampleWorkflowSteps, exampleWorkflowInput: ExampleWorkflowInput, stepInput: StepInput, heartbeatCallback: HeartbeatCallback): StepResult

   

   Run whatever behaviour needs to be run for the given step.

   Run whatever behaviour needs to be run for the given step. There is a recommended strategy for writing these things: see https://github.com/bazaarvoice/super-simple-workflow/blob/master/README.md#writing-steps

   step

   The action to take next

   stepInput

   The input to this particular step

   heartbeatCallback

   A function to call to report liveness and progress. Response true if cancellation is requested.

   returns

   The outcome of the execution.

   Definition Classes

   ExampleWorkflowDefinition → WorkflowDefinition

5. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

6. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

7. final def eq(arg0: AnyRef): Boolean

   

   Definition Classes

   AnyRef

8. def equals(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

9. def finalize(): Unit

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( classOf[java.lang.Throwable] )

10. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

11. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

12. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

13. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

14. final def notify(): Unit

    

    Definition Classes

    AnyRef

15. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

16. def onFail(workflow: String, run: String, exampleWorkflowInput: ExampleWorkflowInput, history: StepsHistory[ExampleWorkflowInput, ExampleWorkflowSteps], message: String): Unit

    

    A hook that gets called when the workflow fails.

    A hook that gets called when the workflow fails. Use this for example to send a notification with an explanation of what happened.

    history

    The history of what happened in the workflow execution.

    message

    A summary of the failure. This is what we also send to SWF as the workflow "result".

    Definition Classes

    ExampleWorkflowDefinition → WorkflowDefinition

17. def onFinish(workflow: String, run: String, exampleWorkflowInput: ExampleWorkflowInput, history: StepsHistory[ExampleWorkflowInput, ExampleWorkflowSteps], message: String): Unit

    

    A hook that gets called when the workflow completes successfully.

    A hook that gets called when the workflow completes successfully. Use this for example to send a notification that the workflow is complete.

    history

    The history of what happened in the workflow execution.

    message

    A description of the workflow result. This is what we also send to SWF as the workflow "result".

    Definition Classes

    ExampleWorkflowDefinition → WorkflowDefinition

18. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

19. def toString(): String

    

    Definition Classes

    AnyRef → Any

20. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

21. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

22. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

23. def workflow(exampleWorkflowInput: ExampleWorkflowInput): List[ScheduledStep[ExampleWorkflowSteps]]

    

    Simply return a list of the workflow steps to execute.

    Simply return a list of the workflow steps to execute.

    Definition Classes

    ExampleWorkflowDefinition → WorkflowDefinition