com.edustructures.sifworks.etranscripts
Class StudentSpecialEducationRecord

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.etranscripts.StudentSpecialEducationRecord

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StudentSpecialEducationRecord
extends SIFDataObject

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

StudentSpecialEducationRecord()
Constructor

StudentSpecialEducationRecord(java.lang.String refId, java.lang.String sifRefId, TranscriptRecordRefObject sifRefObject)
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
LEAInfoData	getLEAInfoData() Gets the value of the <LEAInfoData> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
java.util.Calendar	getReportingDate() Gets the value of the <ReportingDate> element.
SchoolInfoData	getSchoolInfoData() Gets the value of the <SchoolInfoData> element.
java.lang.String	getSIF_RefId() Gets the value of the SIF_RefId attribute.
java.lang.String	getSIF_RefObject() Gets the value of the SIF_RefObject attribute.
StudentParticipationData	getStudentParticipationData() Gets the value of the <StudentParticipationData> element.
void	removeLEAInfoData() Removes the LEAInfoData child element previously created by calling setLEAInfoData
void	removeSchoolInfoData() Removes the SchoolInfoData child element previously created by calling setSchoolInfoData
void	removeStudentParticipationData() Removes the StudentParticipationData child element previously created by calling setStudentParticipationData
void	setLEAInfoData(LEAInfoData value) Sets the value of the <LEAInfoData> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setReportingDate(java.util.Calendar value) Sets the value of the <ReportingDate> element.
void	setSchoolInfoData(SchoolInfoData value) Sets the value of the <SchoolInfoData> element.
void	setSIF_RefId(java.lang.String value) Sets the value of the SIF_RefId attribute.
void	setSIF_RefObject(java.lang.String value) Sets the value of the SIF_RefObject attribute as a String.
void	setSIF_RefObject(TranscriptRecordRefObject value) Sets the value of the SIF_RefObject attribute.
void	setStudentParticipationData(StudentParticipationData value) Sets the value of the <StudentParticipationData> element.

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

StudentSpecialEducationRecord

public StudentSpecialEducationRecord()

Constructor

StudentSpecialEducationRecord

public StudentSpecialEducationRecord(java.lang.String refId,
                                     java.lang.String sifRefId,
                                     TranscriptRecordRefObject sifRefObject)

Constructor that accepts values for all mandatory fields

Parameters:

refId - The ID (GUID) of this record.

sifRefId - The GUID of an associated object, either StudentRecordExchange or StudentPersonal.

sifRefObject - The associated object type.

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: "The ID (GUID) of this record."

Overrides:

getRefId in class SIFDataObject

Returns:

The RefId attribute of this object.

Since:

2.0

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: "The ID (GUID) of this record."

Parameters:

value - A String object

Since:

2.0

getSIF_RefId

public java.lang.String getSIF_RefId()

Gets the value of the SIF_RefId attribute.

The SIF specification defines the meaning of this attribute as: "The GUID of an associated object, either StudentRecordExchange or StudentPersonal."

Returns:

The SIF_RefId attribute of this object.

Since:

2.0

setSIF_RefId

public void setSIF_RefId(java.lang.String value)

Sets the value of the SIF_RefId attribute.

The SIF specification defines the meaning of this attribute as: "The GUID of an associated object, either StudentRecordExchange or StudentPersonal."

Parameters:

value - A String object

Since:

2.0

getSIF_RefObject

public java.lang.String getSIF_RefObject()

Gets the value of the SIF_RefObject attribute.

The SIF specification defines the meaning of this attribute as: "The associated object type."

Returns:

The SIF_RefObject attribute of this object.

Since:

2.0

setSIF_RefObject

public void setSIF_RefObject(TranscriptRecordRefObject value)

Sets the value of the SIF_RefObject attribute.

The SIF specification defines the meaning of this attribute as: "The associated object type."

Parameters:

value - A constant defined by the TranscriptRecordRefObject class

Since:

2.0

setSIF_RefObject

public void setSIF_RefObject(java.lang.String value)

Sets the value of the SIF_RefObject attribute as a String.

The SIF specification defines the meaning of this attribute as: "The associated object type."

Parameters:

value - The value as a String

Since:

2.0

getReportingDate

public java.util.Calendar getReportingDate()

Gets the value of the <ReportingDate> element.

The SIF specification defines the meaning of this element as: "The date this record was prepared."

Returns:

The ReportingDate element of this object.

Since:

2.0

setReportingDate

public void setReportingDate(java.util.Calendar value)

Sets the value of the <ReportingDate> element.

The SIF specification defines the meaning of this element as: "The date this record was prepared."

Parameters:

value - A Calendar object

Since:

2.0

setLEAInfoData

public void setLEAInfoData(LEAInfoData value)

Sets the value of the <LEAInfoData> element.

Parameters:

value - A LEAInfoData object

Since:

2.0

getLEAInfoData

public LEAInfoData getLEAInfoData()

Gets the value of the <LEAInfoData> element.

Returns:

A LEAInfoData object

Since:

2.0

removeLEAInfoData

public void removeLEAInfoData()

Removes the LEAInfoData child element previously created by calling setLEAInfoData

Since:

2.0

setSchoolInfoData

public void setSchoolInfoData(SchoolInfoData value)

Sets the value of the <SchoolInfoData> element.

Parameters:

value - A SchoolInfoData object

Since:

2.0

getSchoolInfoData

public SchoolInfoData getSchoolInfoData()

Gets the value of the <SchoolInfoData> element.

Returns:

A SchoolInfoData object

Since:

2.0

removeSchoolInfoData

public void removeSchoolInfoData()

Removes the SchoolInfoData child element previously created by calling setSchoolInfoData

Since:

2.0

setStudentParticipationData

public void setStudentParticipationData(StudentParticipationData value)

Sets the value of the <StudentParticipationData> element.

Parameters:

value - A StudentParticipationData object

Since:

2.0

getStudentParticipationData

public StudentParticipationData getStudentParticipationData()

Gets the value of the <StudentParticipationData> element.

Returns:

A StudentParticipationData object

Since:

2.0

removeStudentParticipationData

public void removeStudentParticipationData()

Removes the StudentParticipationData child element previously created by calling setStudentParticipationData

Since:

2.0