org.lsst.ccs.bus.messages

Class CommandResult

java.lang.Object

org.lsst.ccs.bus.messages.BusMessage

org.lsst.ccs.bus.messages.CommandMessage

org.lsst.ccs.bus.messages.CommandReply

org.lsst.ccs.bus.messages.CommandResult

All Implemented Interfaces:

Serializable

public class CommandResult
extends CommandReply

The result of a CommandRequest. The execution could be either successful or in error. This is reflected by the status field AND by 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, Object reply, String commandOriginatorId) Constructor for successful execution.
CommandResult(CommandRequest command, Throwable th, String commandOriginatorId) Constructor for a CommandResult that produced an exception.

Method Summary

Modifier and Type	Method and Description
Object	getResult() Get the result of the CommandRequest execution.
String	toString()

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

getCommand, getCommandOriginatorId, getReply

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

getCorrelId, getDestination

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

getOriginAgentInfo, getSummary, getTimeStamp, setOriginAgentInfo, setSummary

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandResult

public CommandResult(CommandRequest command,
                     Object reply,
                     String commandOriginatorId)

Constructor for successful execution.

Parameters:

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

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

commandOriginatorId -

CommandResult

public CommandResult(CommandRequest command,
                     Throwable th,
                     String commandOriginatorId)

Constructor for a CommandResult that produced an exception. The Exception is passed to the constructor as the reply.

Parameters:

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

th - The Exception

commandOriginatorId -

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.

toString

public String toString()

Overrides:

toString in class Object