com.edustructures.sifworks.etranscripts
Class StudentSchoolEnrollmentHistory

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.etranscripts.StudentSchoolEnrollmentHistory

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StudentSchoolEnrollmentHistory
extends SIFKeyedElement

A list of each enrollment in the list of schools attended

Since:

2.0

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

StudentSchoolEnrollmentHistory()
Constructor

StudentSchoolEnrollmentHistory(java.lang.String schoolAttendedRefId, java.lang.Integer schoolYear, PartialDateType entryDate)
Constructor that accepts values for all mandatory fields

Method Summary

PartialDateType	getEntryDate() Gets the value of the <EntryDate> element.
PartialDateType	getExitDate() Gets the value of the <ExitDate> 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	getSchoolAttendedRefId() Gets the value of the SchoolAttendedRefId attribute.
java.lang.Integer	getSchoolYear() Gets the value of the <SchoolYear> element.
void	removeEntryDate() Removes the EntryDate child element previously created by calling setEntryDate
void	removeExitDate() Removes the ExitDate child element previously created by calling setExitDate
void	setEntryDate(PartialDateType value) Sets the value of the <EntryDate> element.
void	setEntryDate(java.lang.String value) Sets the value of the <EntryDate> child element.
void	setExitDate(PartialDateType value) Sets the value of the <ExitDate> element.
void	setExitDate(java.lang.String value) Sets the value of the <ExitDate> child element.
void	setSchoolAttendedRefId(java.lang.String value) Sets the value of the SchoolAttendedRefId attribute.
void	setSchoolYear(java.lang.Integer value) Sets the value of the <SchoolYear> 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

StudentSchoolEnrollmentHistory

public StudentSchoolEnrollmentHistory()

Constructor

StudentSchoolEnrollmentHistory

public StudentSchoolEnrollmentHistory(java.lang.String schoolAttendedRefId,
                                      java.lang.Integer schoolYear,
                                      PartialDateType entryDate)

Constructor that accepts values for all mandatory fields

Parameters:

schoolAttendedRefId - Reference to School Attended.

schoolYear -

entryDate -

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

getSchoolAttendedRefId

public java.lang.String getSchoolAttendedRefId()

Gets the value of the SchoolAttendedRefId attribute.

The SIF specification defines the meaning of this attribute as: "Reference to School Attended."

Returns:

The SchoolAttendedRefId attribute of this object.

Since:

2.0

setSchoolAttendedRefId

public void setSchoolAttendedRefId(java.lang.String value)

Sets the value of the SchoolAttendedRefId attribute.

The SIF specification defines the meaning of this attribute as: "Reference to School Attended."

Parameters:

value - A String object

Since:

2.0

getSchoolYear

public java.lang.Integer getSchoolYear()

Gets the value of the <SchoolYear> element.

Returns:

The SchoolYear element of this object.

Since:

2.0

setSchoolYear

public void setSchoolYear(java.lang.Integer value)

Sets the value of the <SchoolYear> element.

Parameters:

value - A Integer object

Since:

2.0

setEntryDate

public void setEntryDate(PartialDateType value)

Sets the value of the <EntryDate> element.

Parameters:

value - A PartialDateType object

Since:

2.0

setEntryDate

public void setEntryDate(java.lang.String value)

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

Parameters:

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

Since:

2.0

getEntryDate

public PartialDateType getEntryDate()

Gets the value of the <EntryDate> element.

Returns:

A PartialDateType object

Since:

2.0

removeEntryDate

public void removeEntryDate()

Removes the EntryDate child element previously created by calling setEntryDate

Since:

2.0

setExitDate

public void setExitDate(PartialDateType value)

Sets the value of the <ExitDate> element.

Parameters:

value - A PartialDateType object

Since:

2.0

setExitDate

public void setExitDate(java.lang.String value)

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

Parameters:

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

Since:

2.0

getExitDate

public PartialDateType getExitDate()

Gets the value of the <ExitDate> element.

Returns:

A PartialDateType object

Since:

2.0

removeExitDate

public void removeExitDate()

Removes the ExitDate child element previously created by calling setExitDate

Since:

2.0