Package csw.params.commands

Interface CommandResponse

All Superinterfaces:

CommandSerializable

All Known Subinterfaces:

CommandResponse.MatchingResponse, CommandResponse.OnewayResponse, CommandResponse.SubmitResponse, CommandResponse.ValidateCommandResponse, CommandResponse.ValidateResponse

All Known Implementing Classes:

CommandResponse.Accepted, CommandResponse.Cancelled, CommandResponse.Completed, CommandResponse.Error, CommandResponse.Invalid, CommandResponse.Locked, CommandResponse.Started

public interface CommandResponse
extends CommandSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CommandResponse.Accepted	Represents a final response stating acceptance of a command received meaning passed validation
static class	CommandResponse.Accepted$
static class	CommandResponse.Cancelled	Represents a negative response that describes the cancellation of command
static class	CommandResponse.Cancelled$
static class	CommandResponse.Completed	Represents a final positive response stating completion of command with no errors A result may be included or may be empty
static class	CommandResponse.Completed$
static class	CommandResponse.Error	Represents a negative response that describes an error in executing the command
static class	CommandResponse.Error$
static class	CommandResponse.Invalid	Represents a final negative response invalidating a command received has failed validation
static class	CommandResponse.Invalid$
static class	CommandResponse.Locked	Represents a negative response stating that a component is Locked and command was not validated or executed
static class	CommandResponse.Locked$
static interface	CommandResponse.MatchingResponse	MatchingResponse is returned by matchers.
static interface	CommandResponse.OnewayResponse	OnewayResponse is returned by Oneway message which calls the onOneway handler Responses returned can be Accepted, Invalid, Locked
static class	CommandResponse.Started	Represents a preliminary response stating a long running command has been started
static class	CommandResponse.Started$
static interface	CommandResponse.SubmitResponse	SubmitResponse is returned by Submit message which calls the onSubmit handler Responses returned can be Invalid, Started, Completed, Error, Cancelled, Locked
static interface	CommandResponse.ValidateCommandResponse	ValidationResponse is returned by validateCommand handler.
static interface	CommandResponse.ValidateResponse	ValidateOnlyResponse is returned by Validate message, which calls validateCommand handler Values can be Invalid, Accepted, Locked.

Method Summary

Modifier and Type	Method	Description
Id	runId()	A helper method to get the runId for this command response

Method Details

runId

Id runId()

A helper method to get the runId for this command response

Returns:

the runId of command for which this response is created