com.edustructures.sifworks.trans
Class TransStudent

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.trans.TransStudent

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class TransStudent
extends SIFElement

List of students and their status. The complete list may be sent with some events (e.g. change in RouteStatus) per district policy, but it is more typical of responses.

Since:

1.5r1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

TransStudent()
Constructor

TransStudent(java.lang.String studentPersonalRefId, StudentBoardingStatus status, java.lang.String value)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
java.lang.String	getStatus() Gets the value of the Status attribute.
java.lang.String	getStudentPersonalRefId() Gets the value of the StudentPersonalRefId attribute.
java.lang.String	getValue() Gets the value of the <Value> element.
void	setStatus(java.lang.String value) Sets the value of the Status attribute as a String.
void	setStatus(StudentBoardingStatus value) Sets the value of the Status attribute.
void	setStudentPersonalRefId(java.lang.String value) Sets the value of the StudentPersonalRefId attribute.
void	setValue(java.lang.String value) Sets the value of the <Value> element.

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getSIFVersion, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, setSIFVersion, setTextValue, setXmlId, tag

Methods inherited from class com.edustructures.sifworks.Element

compareTo, getElementDef, getParent, getRoot, isChanged, isDoNotEncode, isEmpty, setChanged, setDoNotEncode, setElementDef, setEmpty, setParent, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TransStudent

public TransStudent()

Constructor

TransStudent

public TransStudent(java.lang.String studentPersonalRefId,
                    StudentBoardingStatus status,
                    java.lang.String value)

Constructor that accepts values for all mandatory fields

Parameters:

studentPersonalRefId - GUID that identifies the student that this element refers to.

status - Boarding status of this student

value - Gets or sets the content value of the <TransStudent> element

Method Detail

getKey

public java.lang.String getKey()

Gets the key of this object

Overrides:

getKey in class SIFElement

Returns:

The value of the object's Mandatory or Required attribute. If an object has more than one such attribute, the key is a period- delimited concatenation of the attribute values in sequential order

getKeyFields

public ElementDef[] getKeyFields()

Gets the metadata fields that make up the key of this object

Returns:

an array of metadata fields that make up the object's key

getValue

public java.lang.String getValue()

Gets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "Gets or sets the content value of the <TransStudent> element"

Returns:

The Value element of this object.

Since:

1.5r1

setValue

public void setValue(java.lang.String value)

Sets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "Gets or sets the content value of the <TransStudent> element"

Parameters:

value - A String object

Since:

1.5r1

getStudentPersonalRefId

public java.lang.String getStudentPersonalRefId()

Gets the value of the StudentPersonalRefId attribute.

The SIF specification defines the meaning of this attribute as: "GUID that identifies the student that this element refers to."

Returns:

The StudentPersonalRefId attribute of this object.

Since:

1.5r1

setStudentPersonalRefId

public void setStudentPersonalRefId(java.lang.String value)

Sets the value of the StudentPersonalRefId attribute.

The SIF specification defines the meaning of this attribute as: "GUID that identifies the student that this element refers to."

Parameters:

value - A String object

Since:

1.5r1

getStatus

public java.lang.String getStatus()

Gets the value of the Status attribute.

The SIF specification defines the meaning of this attribute as: "Boarding status of this student"

Returns:

The Status attribute of this object.

Since:

1.5r1

setStatus

public void setStatus(StudentBoardingStatus value)

Sets the value of the Status attribute.

The SIF specification defines the meaning of this attribute as: "Boarding status of this student"

Parameters:

value - A constant defined by the StudentBoardingStatus class

Since:

1.5r1

setStatus

public void setStatus(java.lang.String value)

Sets the value of the Status attribute as a String.

The SIF specification defines the meaning of this attribute as: "Boarding status of this student"

Parameters:

value - The value as a String

Since:

1.5r1