net.sf.freecol.common.networking
Class AssignTeacherMessage

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

public class AssignTeacherMessage
extends DOMMessage

The message sent when assigning a teacher.

Field Summary

private java.lang.String	studentId The id of the student.
private java.lang.String	teacherId The id of the teacher.

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

document, logger

Constructor Summary

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

AssignTeacherMessage(Unit student, Unit teacher)
Create a new AssignTeacherMessage with the supplied student and teacher.

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 "assignTeacher"-message.
org.w3c.dom.Element	toXMLElement() Convert this AssignTeacherMessage 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

studentId

private java.lang.String studentId

The id of the student.

teacherId

private java.lang.String teacherId

The id of the teacher.

Constructor Detail

AssignTeacherMessage

public AssignTeacherMessage(Unit student,
                            Unit teacher)

Create a new AssignTeacherMessage with the supplied student and teacher.

Parameters:

student - The student Unit.

teacher - The teacher Unit.

AssignTeacherMessage

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

Create a new AssignTeacherMessage 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 "assignTeacher"-message.

Parameters:

server - The FreeColServer handling the message.

player - The Player the message applies to.

connection - The Connection message was received on.

Returns:

An update containing the student-teacher assignment or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"assignTeacher".