com.edustructures.sifworks.etranscripts
Class StudentDemographicRecord

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StudentDemographicRecord
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

StudentDemographicRecord()
Constructor

StudentDemographicRecord(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
java.lang.String	getRefId() Gets the value of the RefId attribute.
java.util.Calendar	getReportingDate() Gets the value of the <ReportingDate> 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.
StudentContactsSummary	getStudentContactsSummary() Gets the value of the <StudentContactsSummary> element.
StudentPersonalData	getStudentPersonalData() Gets the value of the <StudentPersonalData> element.
void	removeStudentContactsSummary() Removes the StudentContactsSummary child element previously created by calling setStudentContactsSummary
void	removeStudentPersonalData() Removes the StudentPersonalData child element previously created by calling setStudentPersonalData
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	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	setStudentContactsSummary(StudentContactsSummary value) Sets the value of the <StudentContactsSummary> element.
void	setStudentPersonalData(StudentPersonalData value) Sets the value of the <StudentPersonalData> 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

StudentDemographicRecord

public StudentDemographicRecord()

Constructor

StudentDemographicRecord

public StudentDemographicRecord(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

setStudentPersonalData

public void setStudentPersonalData(StudentPersonalData value)

Sets the value of the <StudentPersonalData> element.

Parameters:

value - A StudentPersonalData object

Since:

2.0

getStudentPersonalData

public StudentPersonalData getStudentPersonalData()

Gets the value of the <StudentPersonalData> element.

Returns:

A StudentPersonalData object

Since:

2.0

removeStudentPersonalData

public void removeStudentPersonalData()

Removes the StudentPersonalData child element previously created by calling setStudentPersonalData

Since:

2.0

setStudentContactsSummary

public void setStudentContactsSummary(StudentContactsSummary value)

Sets the value of the <StudentContactsSummary> element.

Parameters:

value - A StudentContactsSummary object

Since:

2.0

getStudentContactsSummary

public StudentContactsSummary getStudentContactsSummary()

Gets the value of the <StudentContactsSummary> element.

Returns:

A StudentContactsSummary object

Since:

2.0

removeStudentContactsSummary

public void removeStudentContactsSummary()

Removes the StudentContactsSummary child element previously created by calling setStudentContactsSummary

Since:

2.0