Trait

core3.workflows

WorkflowBase

Related Doc: package workflows

Permalink

trait WorkflowBase extends AnyRef

Base class for defining workflows.

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WorkflowBase
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def executeAction(requestID: RequestID, user: UserTokenBase, params: WorkflowParameters, data: InputData)(implicit ec: ExecutionContext): Future[(WorkflowResult, OutputData)]

    Permalink

    Executes the workflow's action with the supplied parameters and data.

    Executes the workflow's action with the supplied parameters and data.

    requestID

    the ID of the workflow request

    user

    the user that made the request

    params

    the parameters to use

    data

    the data to work with

    returns

    a tuple containing the result of the operation and any updated data to be stored by the engine

  2. abstract def loadData(params: WorkflowParameters, queryHandlers: DataQueryHandlers)(implicit ec: ExecutionContext): Future[InputData]

    Permalink

    Loads all data that will be needed for the workflow to execute its action.

    Loads all data that will be needed for the workflow to execute its action.

    params

    the parameters to use

    queryHandlers

    a container holding all relevant query handlers (as supplied by a core3.workflows.WorkflowEngineComponent

    returns

    the collected data

  3. abstract def name: String

    Permalink

    Retrieves the unique name of the workflow.

    Retrieves the unique name of the workflow.

    returns

    the workflow name

  4. abstract def parseParameters(rawParams: JsValue)(implicit ec: ExecutionContext): Future[WorkflowParameters]

    Permalink

    Verifies and converts the supplied raw JSON parameters into a format that can be used by the workflow.

    Verifies and converts the supplied raw JSON parameters into a format that can be used by the workflow.

    rawParams

    the raw parameters to parse

    returns

    the parsed parameters

  5. abstract def readOnly: Boolean

    Permalink

    Specifies whether the workflow is read-only or it makes changes.

    Specifies whether the workflow is read-only or it makes changes.

    A workflow specified as read-only will not be allowed to commit data.

    returns

    true, if the workflow makes no data changes

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. def withSensitiveData: Boolean

    Permalink

    Specifies whether the data contains sensitive information that should not be stored in the transaction logs.

    Specifies whether the data contains sensitive information that should not be stored in the transaction logs.

    returns

    true, if the data contains sensitive info

  21. def withSensitiveParams: Boolean

    Permalink

    Specifies whether the parameters contain sensitive information that should not be stored in the transaction logs.

    Specifies whether the parameters contain sensitive information that should not be stored in the transaction logs.

    returns

    true, if the parameters contain sensitive info

Inherited from AnyRef

Inherited from Any

Ungrouped