net.sf.freecol.common.networking
Class GetTransactionMessage

java.lang.Object
  net.sf.freecol.common.networking.DOMMessage
      net.sf.freecol.common.networking.GetTransactionMessage

public class GetTransactionMessage
extends DOMMessage

The message sent to initiate a transaction.

Field Summary

private java.lang.String	settlementId The ID of the settlement at which the transaction occurs.
private java.lang.String	unitId The ID of the unit performing the transaction.

Fields inherited from class net.sf.freecol.common.networking.DOMMessage

document, logger

Constructor Summary

GetTransactionMessage(Game game, org.w3c.dom.Element element)
Create a new GetTransactionMessage from a supplied element.

GetTransactionMessage(Unit unit, Settlement settlement)
Create a new GetTransactionMessage with the supplied unit and settlement.

Method Summary

static java.lang.String	getXMLElementTagName() The tag name of the root element representing this object.
org.w3c.dom.Element	handle(FreeColServer server, Player player, Connection connection) Handle a "getTransaction"-message.
org.w3c.dom.Element	toXMLElement() Convert this GetTransactionMessage to XML.

Methods inherited from class net.sf.freecol.common.networking.DOMMessage

clientError, collapseElements, createError, createError, createNewDocument, createNewRootElement, elementToString, getAttribute, getChildElement, getDocument, getFreeColProtocolVersion, getType, hasAttribute, insertAsRoot, isType, setAttribute, setAttribute, toString

Methods inherited from class java.lang.Object

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

Field Detail

unitId

private java.lang.String unitId

The ID of the unit performing the transaction.

settlementId

private java.lang.String settlementId

The ID of the settlement at which the transaction occurs.

Constructor Detail

GetTransactionMessage

public GetTransactionMessage(Unit unit,
                             Settlement settlement)

Create a new GetTransactionMessage with the supplied unit and settlement.

Parameters:

unit - The Unit performing the transaction.

settlement - The Settlement where the transaction occurs.

GetTransactionMessage

public GetTransactionMessage(Game game,
                             org.w3c.dom.Element element)

Create a new GetTransactionMessage from a supplied element.

Parameters:

game - The Game this message belongs to.

element - The Element to use to create the message.

Method Detail

handle

public org.w3c.dom.Element handle(FreeColServer server,
                                  Player player,
                                  Connection connection)

Handle a "getTransaction"-message.

Parameters:

server - The FreeColServer handling the message.

player - The Player the message applies to.

connection - The Connection message was received on.

Returns:

A reply encapsulating the possibilities for this transaction, or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

Convert this GetTransactionMessage to XML.

Overrides:

toXMLElement in class DOMMessage

Returns:

The XML representation of this message.

getXMLElementTagName

public static java.lang.String getXMLElementTagName()

The tag name of the root element representing this object.

Returns:

"getTransaction".