org.lsst.ccs.bus.messages

Class CommandNack<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.CommandNack<T>

Type Parameters:

T - The template for the embedded object.

All Implemented Interfaces:

Serializable

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

Command NACK. Returned when a CommandRequest has been rejected and will not be carried out.

Author:

emarin

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CommandNack(CommandRequest command, T reason) CommandNacks are built from the corresponding CommandRequest and the reason for which the command will not be carried out.

Method Summary

Modifier and Type	Method and Description
String	getReason() The reason for the refusal.

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

encodeObject, getEncodedData, getReply

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

getCorrelationId, getCorrelId, getDestination

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

getClassName, getObject, getOriginAgentInfo, getSerializedObject, getTimeStamp, setOriginAgentInfo, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandNack

public CommandNack(CommandRequest command,
                   T reason)

CommandNacks are built from the corresponding CommandRequest and the reason for which the command will not be carried out.

Parameters:

command - The CommandRequest that originated the nack.

reason - The reason the command will not be carried out.

Method Detail

getReason

public String getReason()

The reason for the refusal. It is the String representation of the provided reason. So this is equivalent to invoking getEncodedData on the BusMessage.

Returns:

The reason for rejecting a CommandRequest.