net.sf.freecol.common.networking
Class GetTransactionMessage

java.lang.Object
  extended by net.sf.freecol.common.networking.Message
      extended by net.sf.freecol.common.networking.GetTransactionMessage

public class GetTransactionMessage
extends Message

The message sent to initiate a transaction.


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.Message
clientError, createError, createError, createNewDocument, createNewRootElement, getAttribute, getChildElement, getDocument, getFreeColProtocolVersion, getType, hasAttribute, insertAsRoot, isType, setAttribute, setAttribute, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

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 Message
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".