cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages

Class DialogCommand

java.lang.Object

cz.cuni.amis.pogamut.base.communication.messages.InfoMessage

cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.DialogCommand

All Implemented Interfaces:

IWorldChangeEvent, IWorldEvent, cz.cuni.amis.utils.listener.Event

public class DialogCommand
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event DLGCMD.

Complete message documentation: Asynchronous message. Message with data from dialog.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	Command Type of the command.
protected String	Data Data carried in the message, usually in form "param1=value1¶m2=value2&...¶mN=valueN", equals, ampersands and backslashes are escaped by backslash.
protected String	Id Id of the dialog for with which is this command related to.
static String	PROTOTYPE Example how the message looks like - used during parser tests.
protected long	SimTime
protected String	SourceId Id of the component from where the command originates.

Constructor Summary

Constructors

Constructor and Description
DialogCommand() Parameter-less contructor for the message.
DialogCommand(DialogCommand original) Cloning constructor from the full message.
DialogCommand(String Id, String SourceId, String Command, String Data) Creates new instance of the message DialogCommand.

Method Summary

Methods

Modifier and Type	Method and Description
String	getCommand() Type of the command.
String	getData() Data carried in the message, usually in form "param1=value1¶m2=value2&...¶mN=valueN", equals, ampersands and backslashes are escaped by backslash.
String	getId() Id of the dialog for with which is this command related to.
long	getSimTime() Simulation time in MILLI SECONDS !!!
String	getSourceId() Id of the component from where the command originates.
protected void	setSimTime(long SimTime) Used by Yylex to slip correct time of the object or programmatically.
String	toHtmlString()
String	toJsonLiteral()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PROTOTYPE

public static final String PROTOTYPE

Example how the message looks like - used during parser tests.

See Also:

Constant Field Values

SimTime

protected long SimTime

Id

protected String Id

Id of the dialog for with which is this command related to.

SourceId

protected String SourceId

Id of the component from where the command originates.

Command

protected String Command

Type of the command. SUBMIT and CANCEL carry the data.

Data

protected String Data

Data carried in the message, usually in form "param1=value1¶m2=value2&...¶mN=valueN", equals, ampersands and backslashes are escaped by backslash.

Constructor Detail

DialogCommand

public DialogCommand()

Parameter-less contructor for the message.

DialogCommand

public DialogCommand(String Id,
             String SourceId,
             String Command,
             String Data)

Creates new instance of the message DialogCommand. Asynchronous message. Message with data from dialog. Corresponding GameBots message is DLGCMD.

Parameters:

Id - Id of the dialog for with which is this command related to.

SourceId - Id of the component from where the command originates.

Command - Type of the command. SUBMIT and CANCEL carry the data.

Data - Data carried in the message, usually in form "param1=value1¶m2=value2&...¶mN=valueN", equals, ampersands and backslashes are escaped by backslash.

DialogCommand

public DialogCommand(DialogCommand original)

Cloning constructor from the full message.

Parameters:

original -

Method Detail

getSimTime

public long getSimTime()

Simulation time in MILLI SECONDS !!!

Specified by:

getSimTime in interface IWorldChangeEvent

Specified by:

getSimTime in interface IWorldEvent

setSimTime

protected void setSimTime(long SimTime)

Used by Yylex to slip correct time of the object or programmatically.

getId

public String getId()

Id of the dialog for with which is this command related to.

getSourceId

public String getSourceId()

Id of the component from where the command originates.

getCommand

public String getCommand()

Type of the command. SUBMIT and CANCEL carry the data.

getData

public String getData()

Data carried in the message, usually in form "param1=value1¶m2=value2&...¶mN=valueN", equals, ampersands and backslashes are escaped by backslash.

toString

public String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public String toHtmlString()

toJsonLiteral

public String toJsonLiteral()

Overrides:

toJsonLiteral in class InfoMessage