org.lsst.ccs.bus.messages

Class CommandResult<T extends Serializable>

java.lang.Object

org.lsst.ccs.bus.messages.BusMessage<T,D>

org.lsst.ccs.bus.messages.CommandMessage<T,String>

org.lsst.ccs.bus.messages.CommandReply<T>

org.lsst.ccs.bus.messages.CommandResult<T>

Type Parameters:

T - The template for the embedded object.

All Implemented Interfaces:

Serializable

public final class CommandResult<T extends Serializable>
extends CommandReply<T>

The result of a CommandRequest. The execution could be either successful or in error. This is reflected by by the content of the returned Object. If in error an exception is returned.

Author:

emarin

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CommandResult(CommandRequest command, T reply) Constructor for a CommandResult.

Method Summary

Modifier and Type	Method and Description
Object	getResult() Get the result of the CommandRequest execution.
String	toString()
boolean	wasSuccessful() Was the execution of the CommandRequest successful?

Methods inherited from class org.lsst.ccs.bus.messages.CommandReply

encodeObject, getEncodedData, getReply

Methods inherited from class org.lsst.ccs.bus.messages.CommandMessage

getCorrelationId, getDestination

Methods inherited from class org.lsst.ccs.bus.messages.BusMessage

getClassName, getObject, getOriginAgentInfo, getTimeStamp, setOriginAgentInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandResult

public CommandResult(CommandRequest command,
                     T reply)

Constructor for a CommandResult.

Parameters:

command - The original CommandRequest. This is used for the correlation id.

reply - The result of the execution. It can be null.

Method Detail

getResult

public Object getResult()

Get the result of the CommandRequest execution. If the CommandResultStatus of the execution is: - OK it will contain the object produced by the execution. It can be null. - ERROR it will contain the exception produced by the execution. It cannot be null.

Returns:

The actual result of the execution.

Throws:

EmbeddedObjectDeserializationException - if the embedded object cannot be deserialized.

wasSuccessful

public boolean wasSuccessful()

Was the execution of the CommandRequest successful?

Returns:

true/false

toString

public String toString()

Overrides:

toString in class BusMessage<T extends Serializable,String>