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, 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

protected java.lang.String	Command Type of the command.
protected java.lang.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 java.lang.String	Id Id of the dialog for with which is this command related to.
static java.lang.String	PROTOTYPE Example how the message looks like - used during parser tests.
protected long	SimTime
protected java.lang.String	SourceId Id of the component from where the command originates.

Constructor Summary

DialogCommand()
Parameter-less contructor for the message.

DialogCommand(DialogCommand original)
Cloning constructor from the full message.

DialogCommand(java.lang.String Id, java.lang.String SourceId, java.lang.String Command, java.lang.String Data)
Creates new instance of the message DialogCommand.

Method Summary

java.lang.String	getCommand() Type of the command.
java.lang.String	getData() Data carried in the message, usually in form "param1=value1¶m2=value2&...¶mN=valueN", equals, ampersands and backslashes are escaped by backslash.
java.lang.String	getId() Id of the dialog for with which is this command related to.
long	getSimTime() Returns the simulation time when the event has occurred.
java.lang.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.
java.lang.String	toHtmlString()
java.lang.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 java.lang.String PROTOTYPE

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

See Also:

Constant Field Values

SimTime

protected long SimTime

Id

protected java.lang.String Id

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

SourceId

protected java.lang.String SourceId

Id of the component from where the command originates.

Command

protected java.lang.String Command

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

Data

protected java.lang.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(java.lang.String Id,
                     java.lang.String SourceId,
                     java.lang.String Command,
                     java.lang.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()

Description copied from interface: IWorldEvent

Returns the simulation time when the event has occurred.

Specified by:

getSimTime in interface IWorldChangeEvent

Specified by:

getSimTime in interface IWorldEvent

Returns:

timestamp

setSimTime

protected void setSimTime(long SimTime)

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

getId

public java.lang.String getId()

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

getSourceId

public java.lang.String getSourceId()

Id of the component from where the command originates.

getCommand

public java.lang.String getCommand()

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

getData

public java.lang.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 java.lang.String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public java.lang.String toHtmlString()