csw
API
Generated with
csw/csw/csw.params/csw.params.commands/CommandResponse

CommandResponse

csw.params.commands.CommandResponse
See theCommandResponse companion trait
object CommandResponse

The nature of CommandResponse as an intermediate response of command execution or a final response which could be positive or negative

Attributes

Companion
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

case class Accepted(runId: Id) extends ValidateCommandResponse, ValidateResponse, OnewayResponse

Represents a final response stating acceptance of a command received meaning passed validation

Represents a final response stating acceptance of a command received meaning passed validation

Value parameters

runId

the runId of command for which this response is created

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Cancelled(runId: Id) extends SubmitResponse

Represents a negative response that describes the cancellation of command

Represents a negative response that describes the cancellation of command

Value parameters

runId

of command for which this response is created

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Completed(runId: Id, result: Result) extends SubmitResponse, MatchingResponse

Represents a final positive response stating completion of command with no errors A result may be included or may be empty

Represents a final positive response stating completion of command with no errors A result may be included or may be empty

Value parameters

result

describing the result of completion if needed

runId

of command for which this response is created

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Completed

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Completed.type
case class Error(runId: Id, message: String) extends SubmitResponse, MatchingResponse

Represents a negative response that describes an error in executing the command

Represents a negative response that describes an error in executing the command

Value parameters

message

describing the reason or cause or action item of the error encountered while executing the command

runId

of command for which this response is created

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Invalid(runId: Id, issue: CommandIssue) extends ValidateCommandResponse, ValidateResponse, OnewayResponse, SubmitResponse, MatchingResponse

Represents a final negative response invalidating a command received has failed validation

Represents a final negative response invalidating a command received has failed validation

Value parameters

issue

describing the cause of invalidation

runId

of command for which this response is created

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Locked(runId: Id) extends ValidateResponse, OnewayResponse, SubmitResponse, MatchingResponse

Represents a negative response stating that a component is Locked and command was not validated or executed

Represents a negative response stating that a component is Locked and command was not validated or executed

Value parameters

runId

of command for which this response is created

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait MatchingResponse extends CommandResponse

MatchingResponse is returned by matchers. Responses returned can be Invalid, Completed, Error, Locked

MatchingResponse is returned by matchers. Responses returned can be Invalid, Completed, Error, Locked

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Completed
class Error
class Invalid
class Locked
sealed trait OnewayResponse extends CommandResponse

OnewayResponse is returned by Oneway message which calls the onOneway handler Responses returned can be Accepted, Invalid, Locked

OnewayResponse is returned by Oneway message which calls the onOneway handler Responses returned can be Accepted, Invalid, Locked

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Accepted
class Invalid
class Locked
case class Started(runId: Id) extends SubmitResponse

Represents a preliminary response stating a long running command has been started

Represents a preliminary response stating a long running command has been started

Value parameters

runId

of command for which this response is created

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait SubmitResponse extends CommandResponse

SubmitResponse is returned by Submit message which calls the onSubmit handler Responses returned can be Invalid, Started, Completed, Error, Cancelled, Locked

SubmitResponse is returned by Submit message which calls the onSubmit handler Responses returned can be Invalid, Started, Completed, Error, Cancelled, Locked

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Cancelled
class Completed
class Error
class Invalid
class Locked
class Started
Show all
sealed trait ValidateCommandResponse extends CommandResponse

ValidationResponse is returned by validateCommand handler. Values can only be Invalid, Accepted

ValidationResponse is returned by validateCommand handler. Values can only be Invalid, Accepted

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Accepted
class Invalid
sealed trait ValidateResponse extends CommandResponse

ValidateOnlyResponse is returned by Validate message, which calls validateCommand handler Values can be Invalid, Accepted, Locked. Since the component can be locked, it is ValidationResponse with Locked

ValidateOnlyResponse is returned by Validate message, which calls validateCommand handler Values can be Invalid, Accepted, Locked. Since the component can be locked, it is ValidationResponse with Locked

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Accepted
class Invalid
class Locked

Inherited and Abstract types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def isFinal(sr: SubmitResponse): Boolean

Tests a response to determine if it is a final command state

Tests a response to determine if it is a final command state

Value parameters

sr

response for testing

Attributes

Returns

true if it is final

def isIntermediate(sr: SubmitResponse): Boolean

Tests a response to determine if it is an intermediate response

Tests a response to determine if it is an intermediate response

Value parameters

sr

response for testing

Attributes

Returns

returns true if it is intermediate

def isNegative(sr: SubmitResponse): Boolean

Tests a response to determine if it is a negative response

Tests a response to determine if it is a negative response

Value parameters

sr

response for testing

Attributes

Returns

true if it is negative

def isPositive(sr: SubmitResponse): Boolean

Test a response to determine if it is a positive response

Test a response to determine if it is a positive response

Value parameters

sr

response for testing

Attributes

Returns

true if it is positive

def isPositive(or: OnewayResponse): Boolean

Test a OnewayResponse to determine if it is a positive response

Test a OnewayResponse to determine if it is a positive response

Value parameters

or

a OnewayResponse for testing

Attributes

Returns

true if positive, false otherwise

Generated with