com.edustructures.sifworks.etranscripts
Class EnrollmentHistory

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<StudentSchoolEnrollmentHistory>
                  com.edustructures.sifworks.etranscripts.EnrollmentHistory

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<StudentSchoolEnrollmentHistory>, java.util.Collection<StudentSchoolEnrollmentHistory>

public class EnrollmentHistory
extends SIFKeyedList<StudentSchoolEnrollmentHistory>

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

EnrollmentHistory()
Constructor

EnrollmentHistory(StudentSchoolEnrollmentHistory studentSchoolEnrollmentData)
Constructor that accepts values for all mandatory fields

Method Summary

void	addStudentSchoolEnrollmentData(java.lang.String schoolAttendedRefId, java.lang.Integer schoolYear, PartialDateType entryDate) Adds a new <StudentSchoolEnrollmentData> repeatable element.
StudentSchoolEnrollmentHistory	getStudentSchoolEnrollmentData(java.lang.String schoolAttendedRefId) Gets a StudentSchoolEnrollmentHistory object instance.
StudentSchoolEnrollmentHistory[]	getStudentSchoolEnrollmentDatas() Gets all StudentSchoolEnrollmentHistory object instances.
void	removeStudentSchoolEnrollmentData(java.lang.String schoolAttendedRefId) Removes a StudentSchoolEnrollmentHistory object instance.
void	setStudentSchoolEnrollmentDatas(StudentSchoolEnrollmentHistory[] studentschoolenrollmentdatas) Sets an array of StudentSchoolEnrollmentHistory objects.

Methods inherited from class com.edustructures.sifworks.SIFKeyedList

getChild, getChild

Methods inherited from class com.edustructures.sifworks.SIFList

add, addAll, clear, contains, containsAll, get, iterator, remove, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getKey, 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

Methods inherited from interface java.util.Collection

equals, hashCode, isEmpty

Constructor Detail

EnrollmentHistory

public EnrollmentHistory()

Constructor

EnrollmentHistory

public EnrollmentHistory(StudentSchoolEnrollmentHistory studentSchoolEnrollmentData)

Constructor that accepts values for all mandatory fields

Parameters:

studentSchoolEnrollmentData -

Method Detail

addStudentSchoolEnrollmentData

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

Adds a new <StudentSchoolEnrollmentData> repeatable element. This form of setStudentSchoolEnrollmentData is provided as a convenience method that is functionally equivalent to the version of setStudentSchoolEnrollmentData that accepts a single StudentSchoolEnrollmentHistory object.

Parameters:

schoolAttendedRefId - Reference to School Attended.

schoolYear -

entryDate -

Since:

2.0

removeStudentSchoolEnrollmentData

public void removeStudentSchoolEnrollmentData(java.lang.String schoolAttendedRefId)

Removes a StudentSchoolEnrollmentHistory object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

schoolAttendedRefId - Identifies the StudentSchoolEnrollmentHistory object to remove by its SchoolAttendedRefId value

Since:

2.0

getStudentSchoolEnrollmentData

public StudentSchoolEnrollmentHistory getStudentSchoolEnrollmentData(java.lang.String schoolAttendedRefId)

Gets a StudentSchoolEnrollmentHistory object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

schoolAttendedRefId - Identifies the StudentSchoolEnrollmentHistory object to return by its "SchoolAttendedRefId" attribute value

Returns:

A StudentSchoolEnrollmentHistory object

Since:

2.0

getStudentSchoolEnrollmentDatas

public StudentSchoolEnrollmentHistory[] getStudentSchoolEnrollmentDatas()

Gets all StudentSchoolEnrollmentHistory object instances. More than one instance can be defined for this object because it is a repeatable field element.

Returns:

An array of StudentSchoolEnrollmentHistory objects

Since:

2.0

setStudentSchoolEnrollmentDatas

public void setStudentSchoolEnrollmentDatas(StudentSchoolEnrollmentHistory[] studentschoolenrollmentdatas)

Sets an array of StudentSchoolEnrollmentHistory objects. All existing StudentSchoolEnrollmentHistory instances are removed and replaced with this list. Calling this method with the parameter value set to null removes all StudentSchoolEnrollmentHistorys.

Since:

2.0