com.edustructures.sifworks.student
Class HomeEnrollment

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.student.HomeEnrollment

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class HomeEnrollment
extends SIFElement

Enrollment-related information for the school that is responsible for reporting the student's membership/child accounting information. This is most likely the primary enrollment site for the student.

Since:

1.5r1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

HomeEnrollment()
Constructor

HomeEnrollment(HomeEnrollmentStatus status, GradeLevel gradeLevel)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getFullYearEnrollment() Gets the value of the <FullYearEnrollment> element.
GradeLevel	getGradeLevel() Gets the value of the <GradeLevel> element.
Homeroom	getHomeroom() Gets the value of the <Homeroom> element.
java.lang.String	getHomeroomNumber() Gets the value of the <HomeroomNumber> 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	getLocalId() Gets the value of the <LocalId> element.
java.lang.String	getSchoolInfoRefId() Gets the value of the <SchoolInfoRefId> element.
java.lang.String	getSchoolName() Gets the value of the <SchoolName> element.
java.lang.String	getStateProvinceId() Gets the value of the <StateProvinceId> element.
java.lang.String	getStatus() Gets the value of the <Status> element.
java.lang.String	getStudentSchoolEnrollmentRefId() Gets the value of the <StudentSchoolEnrollmentRefId> element.
void	removeGradeLevel() Removes the GradeLevel child element previously created by calling setGradeLevel
void	removeHomeroom() Removes the Homeroom child element previously created by calling setHomeroom
void	setFullYearEnrollment(java.lang.String value) Sets the value of the <FullYearEnrollment> element as a String.
void	setFullYearEnrollment(YesNoUnknown value) Sets the value of the <FullYearEnrollment> 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	setHomeroom(Homeroom value) Sets the value of the <Homeroom> element.
void	setHomeroom(java.lang.String sifRefObject, java.lang.String value) Sets the value of the <Homeroom> child element.
void	setHomeroomNumber(java.lang.String value) Sets the value of the <HomeroomNumber> element.
void	setLocalId(java.lang.String value) Sets the value of the <LocalId> element.
void	setSchoolInfoRefId(java.lang.String value) Sets the value of the <SchoolInfoRefId> element.
void	setSchoolName(java.lang.String value) Sets the value of the <SchoolName> element.
void	setStateProvinceId(StatePrCode value) Sets the value of the <StateProvinceId> element.
void	setStateProvinceId(java.lang.String value) Sets the value of the <StateProvinceId> element as a String.
void	setStatus(HomeEnrollmentStatus value) Sets the value of the <Status> element.
void	setStatus(java.lang.String value) Sets the value of the <Status> element as a String.
void	setStudentSchoolEnrollmentRefId(java.lang.String value) Sets the value of the <StudentSchoolEnrollmentRefId> 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

HomeEnrollment

public HomeEnrollment()

Constructor

HomeEnrollment

public HomeEnrollment(HomeEnrollmentStatus status,
                      GradeLevel gradeLevel)

Constructor that accepts values for all mandatory fields

Parameters:

status - Enrollment status as of the SnapDate.

gradeLevel - Grade or academic level of student.

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

getStudentSchoolEnrollmentRefId

public java.lang.String getStudentSchoolEnrollmentRefId()

Gets the value of the <StudentSchoolEnrollmentRefId> element. This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"EnrollmentId"
SIF2.0	"StudentSchoolEnrollmentRefId"

Returns:

The StudentSchoolEnrollmentRefId element of this object.

Since:

1.5r1

setStudentSchoolEnrollmentRefId

public void setStudentSchoolEnrollmentRefId(java.lang.String value)

Sets the value of the <StudentSchoolEnrollmentRefId> element. This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"EnrollmentId"
SIF2.0	"StudentSchoolEnrollmentRefId"

Parameters:

value - A String object

Since:

1.5r1

getSchoolName

public java.lang.String getSchoolName()

Gets the value of the <SchoolName> element.

The SIF specification defines the meaning of this element as: "Name of the school."

Returns:

The SchoolName element of this object.

Since:

1.5r1

setSchoolName

public void setSchoolName(java.lang.String value)

Sets the value of the <SchoolName> element.

The SIF specification defines the meaning of this element as: "Name of the school."

Parameters:

value - A String object

Since:

1.5r1

getSchoolInfoRefId

public java.lang.String getSchoolInfoRefId()

Gets the value of the <SchoolInfoRefId> element.

The SIF specification defines the meaning of this element as: "Provide both the HomeEnrollment/SchoolId and HomeEnrollment/LocalId elements if possible. If not, one or the other must be provided."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"SchoolId"
SIF2.0	"SchoolInfoRefId"

Returns:

The SchoolInfoRefId element of this object.

Since:

1.5r1

setSchoolInfoRefId

public void setSchoolInfoRefId(java.lang.String value)

Sets the value of the <SchoolInfoRefId> element.

The SIF specification defines the meaning of this element as: "Provide both the HomeEnrollment/SchoolId and HomeEnrollment/LocalId elements if possible. If not, one or the other must be provided."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"SchoolId"
SIF2.0	"SchoolInfoRefId"

Parameters:

value - A String object

Since:

1.5r1

getLocalId

public java.lang.String getLocalId()

Gets the value of the <LocalId> element.

The SIF specification defines the meaning of this element as: " The locally-defined identifier for this school. Provide both the HomeEnrollment/LocalId and HomeEnrollment/SchoolId elements if possible. If not, one or the other must be provided. "

Returns:

The LocalId element of this object.

Since:

1.5r1

setLocalId

public void setLocalId(java.lang.String value)

Sets the value of the <LocalId> element.

The SIF specification defines the meaning of this element as: " The locally-defined identifier for this school. Provide both the HomeEnrollment/LocalId and HomeEnrollment/SchoolId elements if possible. If not, one or the other must be provided. "

Parameters:

value - A String object

Since:

1.5r1

getStateProvinceId

public java.lang.String getStateProvinceId()

Gets the value of the <StateProvinceId> element.

The SIF specification defines the meaning of this element as: "The state or province defined identifier for this school."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"StatePrId"
SIF2.0	"StateProvinceId"

Returns:

The StateProvinceId element of this object.

Since:

1.5r1

setStateProvinceId

public void setStateProvinceId(StatePrCode value)

Sets the value of the <StateProvinceId> element.

The SIF specification defines the meaning of this element as: "The state or province defined identifier for this school."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"StatePrId"
SIF2.0	"StateProvinceId"

Parameters:

value - A constant defined by the StatePrCode class

Since:

1.5r1

setStateProvinceId

public void setStateProvinceId(java.lang.String value)

Sets the value of the <StateProvinceId> element as a String.

The SIF specification defines the meaning of this element as: "The state or province defined identifier for this school."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"StatePrId"
SIF2.0	"StateProvinceId"

Parameters:

value - The value as a String

Since:

1.5r1

getStatus

public java.lang.String getStatus()

Gets the value of the <Status> element.

The SIF specification defines the meaning of this element as: "Enrollment status as of the SnapDate."

Returns:

The Status element of this object.

Since:

1.5r1

setStatus

public void setStatus(HomeEnrollmentStatus value)

Sets the value of the <Status> element.

The SIF specification defines the meaning of this element as: "Enrollment status as of the SnapDate."

Parameters:

value - A constant defined by the HomeEnrollmentStatus class

Since:

1.5r1

setStatus

public void setStatus(java.lang.String value)

Sets the value of the <Status> element as a String.

The SIF specification defines the meaning of this element as: "Enrollment status as of the SnapDate."

Parameters:

value - The value as a String

Since:

1.5r1

setGradeLevel

public void setGradeLevel(GradeLevel value)

Sets the value of the <GradeLevel> element.

The SIF specification defines the meaning of this element as: "Grade or academic level of student."

Parameters:

value - A GradeLevel object

Since:

1.5r1

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:

1.5r1

getGradeLevel

public GradeLevel getGradeLevel()

Gets the value of the <GradeLevel> element.

The SIF specification defines the meaning of this element as: "Grade or academic level of student."

Returns:

A GradeLevel object

Since:

1.5r1

removeGradeLevel

public void removeGradeLevel()

Removes the GradeLevel child element previously created by calling setGradeLevel

Since:

1.5r1

setHomeroom

public void setHomeroom(Homeroom value)

Sets the value of the <Homeroom> element. This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"HomeroomId"
SIF2.0	"Homeroom"

Parameters:

value - A Homeroom object

Since:

1.5r1

setHomeroom

public void setHomeroom(java.lang.String sifRefObject,
                        java.lang.String value)

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

Parameters:

sifRefObject -

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

Since:

1.5r1

getHomeroom

public Homeroom getHomeroom()

Gets the value of the <Homeroom> element. This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"HomeroomId"
SIF2.0	"Homeroom"

Returns:

An Homeroom object

Since:

1.5r1

removeHomeroom

public void removeHomeroom()

Removes the Homeroom child element previously created by calling setHomeroom

Since:

1.5r1

getHomeroomNumber

public java.lang.String getHomeroomNumber()

Gets the value of the <HomeroomNumber> element.

The SIF specification defines the meaning of this element as: "The locally-defined identifier for this room."

Returns:

The HomeroomNumber element of this object.

Since:

1.5r1

setHomeroomNumber

public void setHomeroomNumber(java.lang.String value)

Sets the value of the <HomeroomNumber> element.

The SIF specification defines the meaning of this element as: "The locally-defined identifier for this room."

Parameters:

value - A String object

Since:

1.5r1

getFullYearEnrollment

public java.lang.String getFullYearEnrollment()

Gets the value of the <FullYearEnrollment> element.

The SIF specification defines the meaning of this element as: "An indication as to whether or not the student was enrolled for the whole school year. If the SchoolYear is in progress as of the SnapDate, use the value "Unknown"."

Returns:

The FullYearEnrollment element of this object.

Since:

1.5r1

setFullYearEnrollment

public void setFullYearEnrollment(YesNoUnknown value)

Sets the value of the <FullYearEnrollment> element.

The SIF specification defines the meaning of this element as: "An indication as to whether or not the student was enrolled for the whole school year. If the SchoolYear is in progress as of the SnapDate, use the value "Unknown"."

Parameters:

value - A constant defined by the YesNoUnknown class

Since:

1.5r1

setFullYearEnrollment

public void setFullYearEnrollment(java.lang.String value)

Sets the value of the <FullYearEnrollment> element as a String.

The SIF specification defines the meaning of this element as: "An indication as to whether or not the student was enrolled for the whole school year. If the SchoolYear is in progress as of the SnapDate, use the value "Unknown"."

Parameters:

value - The value as a String

Since:

1.5r1