com.edustructures.sifworks.etranscripts
Class StudentSchoolEnrollmentData

java.lang.Object
  extended by com.edustructures.sifworks.Element
      extended by com.edustructures.sifworks.SIFElement
          extended by com.edustructures.sifworks.SIFKeyedElement
              extended by com.edustructures.sifworks.etranscripts.StudentSchoolEnrollmentData
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class StudentSchoolEnrollmentData
extends SIFKeyedElement

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
StudentSchoolEnrollmentData()
          Constructor
StudentSchoolEnrollmentData(java.lang.String schoolAttendedRefId)
          Constructor that accepts values for all mandatory fields
 
Method Summary
 Advisor getAdvisor()
          Gets the value of the <Advisor> element.
 Counselor getCounselor()
          Gets the value of the <Counselor> element.
 GradeLevel getGradeLevel()
          Gets the value of the <GradeLevel> 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.
 void removeAdvisor()
          Removes the Advisor child element previously created by calling setAdvisor
 void removeCounselor()
          Removes the Counselor child element previously created by calling setCounselor
 void removeGradeLevel()
          Removes the GradeLevel child element previously created by calling setGradeLevel
 void setAdvisor(Advisor value)
          Sets the value of the <Advisor> element.
 void setCounselor(Counselor value)
          Sets the value of the <Counselor> element.
 void setGradeLevel(GradeLevel value)
          Sets the value of the <GradeLevel> element.
 void setGradeLevel(GradeLevelCode code)
          Sets the value of the <GradeLevel> child element.
 void setSchoolAttendedRefId(java.lang.String value)
          Sets the value of the SchoolAttendedRefId attribute.
 
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

StudentSchoolEnrollmentData

public StudentSchoolEnrollmentData()
Constructor


StudentSchoolEnrollmentData

public StudentSchoolEnrollmentData(java.lang.String schoolAttendedRefId)
Constructor that accepts values for all mandatory fields

Parameters:
schoolAttendedRefId - References the school of record for the student (see SchoolAttended).
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: "References the school of record for the student (see SchoolAttended)."

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: "References the school of record for the student (see SchoolAttended)."

Parameters:
value - A String object
Since:
2.0

setGradeLevel

public void setGradeLevel(GradeLevel value)
Sets the value of the <GradeLevel> element.

Parameters:
value - A GradeLevel object
Since:
2.0

setGradeLevel

public void setGradeLevel(GradeLevelCode code)
Sets the value of the <GradeLevel> child element. This form of setGradeLevel is provided as a convenience method that is functionally equivalent to the version of setGradeLevel that accepts a single GradeLevel object.

Parameters:
code - Code representing the grade level.
Since:
2.0

getGradeLevel

public GradeLevel getGradeLevel()
Gets the value of the <GradeLevel> element.

Returns:
A GradeLevel object
Since:
2.0

removeGradeLevel

public void removeGradeLevel()
Removes the GradeLevel child element previously created by calling setGradeLevel

Since:
2.0

setAdvisor

public void setAdvisor(Advisor value)
Sets the value of the <Advisor> element.

Parameters:
value - A Advisor object
Since:
2.0

getAdvisor

public Advisor getAdvisor()
Gets the value of the <Advisor> element.

Returns:
An Advisor object
Since:
2.0

removeAdvisor

public void removeAdvisor()
Removes the Advisor child element previously created by calling setAdvisor

Since:
2.0

setCounselor

public void setCounselor(Counselor value)
Sets the value of the <Counselor> element.

Parameters:
value - A Counselor object
Since:
2.0

getCounselor

public Counselor getCounselor()
Gets the value of the <Counselor> element.

Returns:
A Counselor object
Since:
2.0

removeCounselor

public void removeCounselor()
Removes the Counselor child element previously created by calling setCounselor

Since:
2.0


Copyright © 2001-2007 Edustructures LLC. All Rights Reserved. SIFWorks® and ADK® are registered trademarks of Edustructures LLC. SIF™ and Schools Interoperability Framework are trademarks of the Schools Interoperability Framework Association.