CommandResponse.Completed

java.lang.Object
- csw.params.commands.CommandResponse.Completed

All Implemented Interfaces:

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

Enclosing interface:

CommandResponse
```
public static class CommandResponse.Completed
extends java.lang.Object
implements CommandResponse.SubmitResponse, CommandResponse.MatchingResponse, scala.Product, java.io.Serializable
```
Represents a final positive response stating completion of command with no errors A result may be included or may be empty
param: runId of command for which this response is created param: result describing the result of completion if needed

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

Completed(Id runId)
A java helper to construct a Completed response

Completed(Id runId, Result result)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`hasResult()`	Check to see if this response has a result
`Result`	`result()`
`Id`	`runId()`	A helper method to get the runId for this command response
`CommandResponse.Completed`	`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 scala.Equals
canEqual, equals

Methods inherited from interface scala.Product
productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

- Constructor Detail
  - Completed
```
public Completed(Id runId,
                 Result result)
```
  - Completed
```
public Completed(Id runId)
```
    A java helper to construct a Completed response
    
    Parameters:
    
    runId - (undocumented)
- Method Detail
  - 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
  - result
```
public Result result()
```
  - hasResult
```
public boolean hasResult()
```
    Check to see if this response has a result
    
    Returns:
    
    true if the response contains a non-empty result, false otherwise.
  - withRunId
```
public CommandResponse.Completed withRunId(Id newRunId)
```
    Specified by:
    
    withRunId in interface CommandResponse.SubmitResponse