Package csw.params.commands

Class CommandResponse.Error

java.lang.Object

csw.params.commands.CommandResponse.Error

All Implemented Interfaces:

CommandResponse, CommandResponse.MatchingResponse, CommandResponse.SubmitResponse, CommandSerializable, Serializable, scala.Equals, scala.Product

Enclosing interface:

CommandResponse

public static class CommandResponse.Error
extends Object
implements CommandResponse.SubmitResponse, CommandResponse.MatchingResponse, scala.Product, Serializable

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

param: runId of command for which this response is created param: message describing the reason or cause or action item of the error encountered while executing the command

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface csw.params.commands.CommandResponse

CommandResponse.Accepted, CommandResponse.Accepted$, CommandResponse.Cancelled, CommandResponse.Cancelled$, CommandResponse.Completed, CommandResponse.Completed$, CommandResponse.Error, CommandResponse.Error$, CommandResponse.Invalid, CommandResponse.Invalid$, CommandResponse.Locked, CommandResponse.Locked$, CommandResponse.MatchingResponse, CommandResponse.OnewayResponse, CommandResponse.Started, CommandResponse.Started$, CommandResponse.SubmitResponse, CommandResponse.ValidateCommandResponse, CommandResponse.ValidateResponse

Constructor Summary

Constructors

Constructor	Description
Error(Id runId, String message)

Method Summary

Modifier and Type	Method	Description
String	message()
Id	runId()	A helper method to get the runId for this command response
CommandResponse.Error	withRunId(Id newRunId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface csw.params.commands.CommandResponse.SubmitResponse

typeName

Methods inherited from interface scala.Equals

canEqual, equals

Methods inherited from interface scala.Product

productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

Constructor Details

Error

public Error(Id runId,
 String message)

Method Details

runId

public Id runId()

Description copied from interface: CommandResponse

A helper method to get the runId for this command response

Specified by:

runId in interface CommandResponse

Returns:

the runId of command for which this response is created

message

public String message()

withRunId

public CommandResponse.Error withRunId(Id newRunId)

Specified by:

withRunId in interface CommandResponse.SubmitResponse