org.commonreality.message.command.control

Class ControlCommand

java.lang.Object

org.commonreality.message.impl.BaseMessage

org.commonreality.message.command.control.ControlCommand

All Implemented Interfaces:

java.io.Serializable, IControlCommand, ICommand, IMessage, IRequest

public class ControlCommand
extends BaseMessage
implements IControlCommand

Author:

developer

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.commonreality.message.command.control.IControlCommand

IControlCommand.State

Constructor Summary

Constructors

Constructor and Description
ControlCommand(IIdentifier source, IControlCommand.State state)
ControlCommand(IIdentifier source, IControlCommand.State state, java.lang.Object extra)

Method Summary

Modifier and Type	Method and Description
boolean	acknowledgementRequired() common reality requires confirmation that this has been handled
IMessage	copy()
java.lang.Object	getData() return additional data
IControlCommand.State	getState() what state should the participants go to

Methods inherited from class org.commonreality.message.impl.BaseMessage

getMessageId, getSource, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.commonreality.message.IMessage

getMessageId, getSource

Constructor Detail

ControlCommand

public ControlCommand(IIdentifier source,
                      IControlCommand.State state,
                      java.lang.Object extra)

Parameters:

source -

ControlCommand

public ControlCommand(IIdentifier source,
                      IControlCommand.State state)

Method Detail

copy

public IMessage copy()

Specified by:

copy in interface IMessage

getState

public IControlCommand.State getState()

Description copied from interface: IControlCommand

what state should the participants go to

Specified by:

getState in interface IControlCommand

Returns:

getData

public java.lang.Object getData()

Description copied from interface: IControlCommand

return additional data

Specified by:

getData in interface IControlCommand

Returns:

See Also:

IControlCommand.getData()

acknowledgementRequired

public boolean acknowledgementRequired()

common reality requires confirmation that this has been handled

Specified by:

acknowledgementRequired in interface IRequest

Returns:

See Also:

IRequest.acknowledgementRequired()