Class/Object

core3.workflows

WorkflowResult

Related Docs: object WorkflowResult | package workflows

Permalink

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.

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)

Linear Supertypes
Serializable, Serializable, Product, Equals, ServiceResponse, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WorkflowResult
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. ServiceResponse
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WorkflowResult(wasSuccessful: Boolean, requestID: RequestID, message: Option[String] = None, data: Option[JsValue] = None)

    Permalink

    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)

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 asJson: JsValue

    Permalink
    Definition Classes
    WorkflowResultServiceResponse
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def combineWith(other: ServiceResponse): ServiceResponse

    Permalink

    Combines the current service response with the supplied one and returns a new one with all data and messages merged.

    Combines the current service response with the supplied one and returns a new one with all data and messages merged.

    Notes: - If one of the service responses was not successful, the new service response should not be successful. - All messages should be preserved, regardless of the success of the responses. - All data should be preserved, regardless of the success of the responses. - Should throw an exception if attempting to combine with itself.

    other

    the service response to combine this one with

    returns

    the new, combined, service response

    Definition Classes
    WorkflowResultServiceResponse
  8. val data: Option[JsValue]

    Permalink

    data associated with the result (optional)

    data associated with the result (optional)

    Definition Classes
    WorkflowResultServiceResponse
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    Any
  13. val message: Option[String]

    Permalink

    a message describing the result (optional)

    a message describing the result (optional)

    Definition Classes
    WorkflowResultServiceResponse
  14. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  17. val requestID: RequestID

    Permalink

    the ID associated with the workflow request

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

    Permalink
    Definition Classes
    AnyRef
  19. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. val wasSuccessful: Boolean

    Permalink

    set to true, if the workflow completed successfully

    set to true, if the workflow completed successfully

    Definition Classes
    WorkflowResultServiceResponse
  23. def withData(data: OutputData): WorkflowResult

    Permalink

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ServiceResponse

Inherited from AnyRef

Inherited from Any

Ungrouped