Package csw.params.commands
Interface CommandResponse
-
- All Superinterfaces:
CommandSerializable
- All Known Subinterfaces:
CommandResponse.MatchingResponse,CommandResponse.OnewayResponse,CommandResponse.QueryResponse,CommandResponse.SubmitResponse,CommandResponse.ValidateCommandResponse,CommandResponse.ValidateResponse
- All Known Implementing Classes:
CommandResponse.Accepted,CommandResponse.Cancelled,CommandResponse.CommandNotAvailable,CommandResponse.Completed,CommandResponse.CompletedWithResult,CommandResponse.Error,CommandResponse.Invalid,CommandResponse.Locked,CommandResponse.Started
public interface CommandResponse extends CommandSerializable
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classCommandResponse.AcceptedRepresents a final response stating acceptance of a command receivedstatic classCommandResponse.Accepted$static classCommandResponse.CancelledRepresents a negative response that describes the cancellation of commandstatic classCommandResponse.Cancelled$static classCommandResponse.CommandNotAvailableA negative response stating that a command with given runId is not available or cannot be locatedstatic classCommandResponse.CommandNotAvailable$static classCommandResponse.CompletedRepresents a positive response stating completion of commandstatic classCommandResponse.Completed$static classCommandResponse.CompletedWithResultRepresents a positive response stating completion of commandstatic classCommandResponse.CompletedWithResult$static classCommandResponse.ErrorRepresents a negative response that describes an error in executing the commandstatic classCommandResponse.Error$static classCommandResponse.InvalidRepresents a negative response invalidating a command receivedstatic classCommandResponse.Invalid$static classCommandResponse.LockedRepresents a negative response stating that a component is Locked and command was not validated or executedstatic classCommandResponse.Locked$static interfaceCommandResponse.MatchingResponseMatchingResponse is returned by matchers.static interfaceCommandResponse.OnewayResponseOnewayResponse is returned by Oneway message which calls the onOneway handler Responses returned can be Accepted, Invalid, Lockedstatic interfaceCommandResponse.QueryResponseQueryResponse is returned by CommandService query Values can be Invalid, Started, Completed, CompletedWithResult, Error, Cancelled, Locked, CommandNotAvailablestatic classCommandResponse.StartedRepresents an intermediate response stating a long running command has been startedstatic classCommandResponse.Started$static interfaceCommandResponse.SubmitResponseSubmitResponse is returned by Submit message which calls the onSubmit handler Responses returned can be Invalid, Started, Completed, CompletedWithResult, Error, Cancelled, Lockedstatic interfaceCommandResponse.ValidateCommandResponseValidationResponse is returned by validateCommand handler.static interfaceCommandResponse.ValidateResponseValidateOnlyResponse is returned by Validate message, which calls validateCommand handler Values can be Invalid, Accepted, Locked.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IdrunId()A helper method to get the runId for this command response
-
-
-
Method Detail
-
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
-
-