com.edustructures.sifworks.trans
Class StudentTransportInfo

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.trans.StudentTransportInfo

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StudentTransportInfo
extends SIFDataObject

This object contains transportation information about a student. Students should have at least two StudentTransportInfo objects associated with them: one for inbound information (getting to school) and one for outbound information (leaving school). If their transportation changes based on the day of the week, then a student will have more than two StudentTransportInfo objects.

Since:

1.1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

StudentTransportInfo()
Constructor

StudentTransportInfo(java.lang.String refId, java.lang.String studentPersonalRefId, StudentTransportInfoType type, java.lang.String dayOfWeek, java.lang.String schoolInfoRefId)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getDayOfWeek() Gets the value of the DayOfWeek attribute.
java.lang.String	getEligibility() Gets the value of the <Eligibility> element.
HomeBusRouteDetail	getHomeBusRouteDetail() Gets the value of the <HomeBusRouteDetail> element.
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	getRefId() Gets the value of the RefId attribute.
SchoolBusRouteDetail	getSchoolBusRouteDetail() Gets the value of the <SchoolBusRouteDetail> element.
java.lang.String	getSchoolInfoRefId() Gets the value of the SchoolInfoRefId attribute.
java.lang.String	getStudentPersonalRefId() Gets the value of the StudentPersonalRefId attribute.
TransferPoints	getTransferPoints() Gets the value of the <TransferPoints> element.
java.lang.String	getType() Gets the value of the Type attribute.
void	removeHomeBusRouteDetail() Removes the HomeBusRouteDetail child element previously created by calling setHomeBusRouteDetail
void	removeSchoolBusRouteDetail() Removes the SchoolBusRouteDetail child element previously created by calling setSchoolBusRouteDetail
void	removeTransferPoints() Removes the TransferPoints child element previously created by calling setTransferPoints
void	setDayOfWeek(java.lang.String value) Sets the value of the DayOfWeek attribute.
void	setEligibility(Eligibility value) Sets the value of the <Eligibility> element.
void	setEligibility(java.lang.String value) Sets the value of the <Eligibility> element as a String.
void	setHomeBusRouteDetail(HomeBusRouteDetail value) Sets the value of the <HomeBusRouteDetail> element.
void	setHomeBusRouteDetail(java.lang.String sifRefObject, java.lang.String value) Sets the value of the <HomeBusRouteDetail> child element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setSchoolBusRouteDetail(SchoolBusRouteDetail value) Sets the value of the <SchoolBusRouteDetail> element.
void	setSchoolBusRouteDetail(java.lang.String sifRefObject, java.lang.String value) Sets the value of the <SchoolBusRouteDetail> child element.
void	setSchoolInfoRefId(java.lang.String value) Sets the value of the SchoolInfoRefId attribute.
void	setStudentPersonalRefId(java.lang.String value) Sets the value of the StudentPersonalRefId attribute.
void	setTransferPoints(TransferPoints value) Sets the value of the <TransferPoints> element.
void	setType(java.lang.String value) Sets the value of the Type attribute as a String.
void	setType(StudentTransportInfoType value) Sets the value of the Type attribute.

Methods inherited from class com.edustructures.sifworks.SIFDataObject

addSIFExtendedElement, clone, getElementOrAttribute, getObjectTag, getObjectType, getSIFExtendedElement, getSIFExtendedElements, getSIFExtendedElementsContainer, getSIFMetadata, getSIFVersion, setElementOrAttribute, setElementOrAttribute, setElementOrAttribute, setSIFExtendedElements, setSIFExtendedElementsContainer, setSIFMetadata, setSIFVersion, toXML

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, 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

StudentTransportInfo

public StudentTransportInfo()

Constructor

StudentTransportInfo

public StudentTransportInfo(java.lang.String refId,
                            java.lang.String studentPersonalRefId,
                            StudentTransportInfoType type,
                            java.lang.String dayOfWeek,
                            java.lang.String schoolInfoRefId)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID that identifies this object.

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

type - The direction of transportation that this object refers to.

dayOfWeek - This attribute indicates the day(s) of the week to which this object refers.

schoolInfoRefId - GUID referring to the school that the student attends on these day(s) of the week.

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

getRefId

public java.lang.String getRefId()

Gets the value of the RefId attribute.

The SIF specification defines the meaning of this attribute as: "GUID that identifies this object."

Overrides:

getRefId in class SIFDataObject

Returns:

The RefId attribute of this object.

Since:

1.1

setRefId

public void setRefId(java.lang.String value)

Sets the value of the RefId attribute.

The SIF specification defines the meaning of this attribute as: "GUID that identifies this object."

Parameters:

value - A String object

Since:

1.1

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 object refers to."

Returns:

The StudentPersonalRefId attribute of this object.

Since:

1.1

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 object refers to."

Parameters:

value - A String object

Since:

1.1

getType

public java.lang.String getType()

Gets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "The direction of transportation that this object refers to."

Returns:

The Type attribute of this object.

Since:

1.1

setType

public void setType(StudentTransportInfoType value)

Sets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "The direction of transportation that this object refers to."

Parameters:

value - A constant defined by the StudentTransportInfoType class

Since:

1.1

setType

public void setType(java.lang.String value)

Sets the value of the Type attribute as a String.

The SIF specification defines the meaning of this attribute as: "The direction of transportation that this object refers to."

Parameters:

value - The value as a String

Since:

1.1

getDayOfWeek

public java.lang.String getDayOfWeek()

Gets the value of the DayOfWeek attribute.

The SIF specification defines the meaning of this attribute as: "This attribute indicates the day(s) of the week to which this object refers."

Returns:

The DayOfWeek attribute of this object.

Since:

1.1

setDayOfWeek

public void setDayOfWeek(java.lang.String value)

Sets the value of the DayOfWeek attribute.

The SIF specification defines the meaning of this attribute as: "This attribute indicates the day(s) of the week to which this object refers."

Parameters:

value - A String object

Since:

1.1

getSchoolInfoRefId

public java.lang.String getSchoolInfoRefId()

Gets the value of the SchoolInfoRefId attribute.

The SIF specification defines the meaning of this attribute as: "GUID referring to the school that the student attends on these day(s) of the week."

Returns:

The SchoolInfoRefId attribute of this object.

Since:

1.1

setSchoolInfoRefId

public void setSchoolInfoRefId(java.lang.String value)

Sets the value of the SchoolInfoRefId attribute.

The SIF specification defines the meaning of this attribute as: "GUID referring to the school that the student attends on these day(s) of the week."

Parameters:

value - A String object

Since:

1.1

getEligibility

public java.lang.String getEligibility()

Gets the value of the <Eligibility> element.

The SIF specification defines the meaning of this element as: "Eligibility status of student for district transportation for this trip."

Returns:

The Eligibility element of this object.

Since:

1.1

setEligibility

public void setEligibility(Eligibility value)

Sets the value of the <Eligibility> element.

The SIF specification defines the meaning of this element as: "Eligibility status of student for district transportation for this trip."

Parameters:

value - A constant defined by the Eligibility class

Since:

1.1

setEligibility

public void setEligibility(java.lang.String value)

Sets the value of the <Eligibility> element as a String.

The SIF specification defines the meaning of this element as: "Eligibility status of student for district transportation for this trip."

Parameters:

value - The value as a String

Since:

1.1

setHomeBusRouteDetail

public void setHomeBusRouteDetail(HomeBusRouteDetail value)

Sets the value of the <HomeBusRouteDetail> element.

The SIF specification defines the meaning of this element as: "If the HomeBusRouteDetail element does not exist then the student does not ride a bus to/from school."

Parameters:

value - A HomeBusRouteDetail object

Since:

1.1

setHomeBusRouteDetail

public void setHomeBusRouteDetail(java.lang.String sifRefObject,
                                  java.lang.String value)

Sets the value of the <HomeBusRouteDetail> child element. This form of setHomeBusRouteDetail is provided as a convenience method that is functionally equivalent to the version of setHomeBusRouteDetail that accepts a single HomeBusRouteDetail object.

Parameters:

sifRefObject - Must be set to BusRouteDetail

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

Since:

1.1

getHomeBusRouteDetail

public HomeBusRouteDetail getHomeBusRouteDetail()

Gets the value of the <HomeBusRouteDetail> element.

The SIF specification defines the meaning of this element as: "If the HomeBusRouteDetail element does not exist then the student does not ride a bus to/from school."

Returns:

An HomeBusRouteDetail object

Since:

1.1

removeHomeBusRouteDetail

public void removeHomeBusRouteDetail()

Removes the HomeBusRouteDetail child element previously created by calling setHomeBusRouteDetail

Since:

1.1

setTransferPoints

public void setTransferPoints(TransferPoints value)

Sets the value of the <TransferPoints> element.

The SIF specification defines the meaning of this element as: "There should be one TransferPoint for each intermediate point on a trip. The "embark" and "disembark" bus stops for a single transfer point must be at the same location. To order multiple TransferPoint elements, use the Time element of the BusStopInfo objects referenced by the attributes."

Parameters:

value - A TransferPoints object

Since:

1.1

getTransferPoints

public TransferPoints getTransferPoints()

Gets the value of the <TransferPoints> element.

The SIF specification defines the meaning of this element as: "There should be one TransferPoint for each intermediate point on a trip. The "embark" and "disembark" bus stops for a single transfer point must be at the same location. To order multiple TransferPoint elements, use the Time element of the BusStopInfo objects referenced by the attributes."

Returns:

A TransferPoints object

Since:

1.1

removeTransferPoints

public void removeTransferPoints()

Removes the TransferPoints child element previously created by calling setTransferPoints

Since:

1.1

setSchoolBusRouteDetail

public void setSchoolBusRouteDetail(SchoolBusRouteDetail value)

Sets the value of the <SchoolBusRouteDetail> element.

The SIF specification defines the meaning of this element as: "If the SchoolBusRouteDetail element does not exist then the student does not ride a bus to/from school."

Parameters:

value - A SchoolBusRouteDetail object

Since:

1.1

setSchoolBusRouteDetail

public void setSchoolBusRouteDetail(java.lang.String sifRefObject,
                                    java.lang.String value)

Sets the value of the <SchoolBusRouteDetail> child element. This form of setSchoolBusRouteDetail is provided as a convenience method that is functionally equivalent to the version of setSchoolBusRouteDetail that accepts a single SchoolBusRouteDetail object.

Parameters:

sifRefObject - GUID referring to a BusRouteDetail object that identifies the origin bus stop for an inbound route or the destination bus stop for an outbound route.

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

Since:

1.1

getSchoolBusRouteDetail

public SchoolBusRouteDetail getSchoolBusRouteDetail()

Gets the value of the <SchoolBusRouteDetail> element.

The SIF specification defines the meaning of this element as: "If the SchoolBusRouteDetail element does not exist then the student does not ride a bus to/from school."

Returns:

A SchoolBusRouteDetail object

Since:

1.1

removeSchoolBusRouteDetail

public void removeSchoolBusRouteDetail()

Removes the SchoolBusRouteDetail child element previously created by calling setSchoolBusRouteDetail

Since:

1.1