net.sf.freecol.common.networking
Class CloseTransactionMessage

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

public class CloseTransactionMessage
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

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

CloseTransactionMessage(Unit unit, Settlement settlement)
Create a new CloseTransactionMessage 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 "closeTransaction"-message.
org.w3c.dom.Element	toXMLElement() Convert this CloseTransactionMessage to XML.

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

clientError, createError, createError, createNewDocument, createNewRootElement, 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

CloseTransactionMessage

public CloseTransactionMessage(Unit unit,
                               Settlement settlement)

Create a new CloseTransactionMessage with the supplied unit and settlement.

Parameters:

unit - The Unit performing the transaction.

settlement - The Settlement where the transaction occurs.

CloseTransactionMessage

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

Create a new CloseTransactionMessage 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 "closeTransaction"-message.

Parameters:

server - The FreeColServer handling the message.

player - The Player the message applies to.

connection - The Connection message was received on.

Returns:

Null, or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

Convert this CloseTransactionMessage 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:

"closeTransaction".