workflows

Type Members

1. case class DataQueryHandlers(getGroup: (String) ⇒ Future[Group], getContainer: (ContainerType, ObjectID) ⇒ Future[Container], getContainerWithRevision: (ContainerType, ObjectID, RevisionID, RevisionSequenceNumber) ⇒ Future[MutableContainer], getContainers: (ContainerType, String, Map[String, String]) ⇒ Future[ContainerSet], getAllContainers: (ContainerType) ⇒ Future[ContainerSet], loadView: (ContainerView) ⇒ Future[Unit]) extends Product with Serializable

   

   Container for workflow data query handlers.

   Container for workflow data query handlers.

   getGroup

   a function for retrieving a group by short name

   getContainer

   a function for retrieving a container by type & ID

   getContainerWithRevision

   a function for retrieving a container by type, ID, revision and revision number

   getContainers

   a function for querying containers

   getAllContainers

   a function for retrieving all containers of a given type

   loadView

   a function for loading views

2. trait InputData extends AnyRef

   

   Base trait for handling incoming workflow data.

3. case class NoInputData() extends InputData with Product with Serializable

   

   An empty core3.workflows.InputData implementation.

   An empty core3.workflows.InputData implementation.

   Can be used when a workflow requires no data from the DB.

4. case class NoWorkflowParameters() extends WorkflowParameters with Product with Serializable

   

   An empty core3.workflows.WorkflowParameters implementation.

   An empty core3.workflows.WorkflowParameters implementation.

   Can be used when a workflow requires no parameters.

5. case class OutputData(add: Vector[Container] = Vector.empty, update: Vector[MutableContainer] = Vector.empty, delete: Vector[MutableContainer] = Vector.empty) extends Product with Serializable

   

   Container for handling outgoing workflow data.

   Container for handling outgoing workflow data.

   add

   a list of containers to be added

   update

   a list of containers to be updated

   delete

   a list of containers to be removed

6. type RequestID = UUID

   

7. sealed trait StoreTransactionLogs extends AnyRef

   

8. trait WorkflowBase extends AnyRef

   

   Base class for defining workflows.

9. class WorkflowEngine extends AnyRef

   

   A wrapper class for sending requests to core3.workflows.WorkflowEngineComponent actors.

10. class WorkflowEngineComponent extends Component

    

    Main system component for executing workflows.

11. trait WorkflowParameters extends AnyRef

    

    Base trait for handling parsed workflow parameters.

12. case class WorkflowRequest(workflowName: String, rawParams: JsValue, returnOutputData: Boolean = false) extends Product with Serializable

    

    Container class for workflow requests.

    Container class for workflow requests.

    workflowName

    the requested workflow name

    rawParams

    the parameters for the workflow

13. case class WorkflowResult(wasSuccessful: Boolean, requestID: RequestID, message: Option[String] = None, data: Option[JsValue] = None) extends ServiceResponse with Product with Serializable

    

    Container class for workflow results.

    Container class for workflow results.

    wasSuccessful

    set to true, if the workflow completed successfully

    requestID

    the ID associated with the workflow request

    message

    a message describing the result (optional)

    data

    data associated with the result (optional)