com.edustructures.sifworks.assessment
Class AssessmentRegistration

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.assessment.AssessmentRegistration

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

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

AssessmentRegistration()
Constructor

AssessmentRegistration(java.lang.String refId, java.lang.String studentPersonalRefId, java.lang.String assessmentAdministrationRefId)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getAssessmentAdministrationRefId() Gets the value of the AssessmentAdministrationRefId attribute.
GradeLevel	getAssessmentGradeLevel() Gets the value of the <AssessmentGradeLevel> element.
java.util.Calendar	getCreationDateTime() Gets the value of the <CreationDateTime> 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	getLEAInfoRefId() Gets the value of the <LEAInfoRefId> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
java.lang.String	getSchoolInfoRefId() Gets the value of the <SchoolInfoRefId> element.
java.lang.String	getSectionInfoRefId() Gets the value of the <SectionInfoRefId> element.
java.lang.String	getStaffPersonalRefId() Gets the value of the <StaffPersonalRefId> element.
GradeLevel	getStudentGradeLevel() Gets the value of the <StudentGradeLevel> element.
java.lang.String	getStudentPersonalRefId() Gets the value of the StudentPersonalRefId attribute.
StudentSpecialConditions	getStudentSpecialConditions() Gets the value of the <StudentSpecialConditions> element.
void	removeAssessmentGradeLevel() Removes the AssessmentGradeLevel child element previously created by calling setAssessmentGradeLevel
void	removeStudentGradeLevel() Removes the StudentGradeLevel child element previously created by calling setStudentGradeLevel
void	removeStudentSpecialConditions() Removes the StudentSpecialConditions child element previously created by calling setStudentSpecialConditions
void	setAssessmentAdministrationRefId(java.lang.String value) Sets the value of the AssessmentAdministrationRefId attribute.
void	setAssessmentGradeLevel(GradeLevel value) Sets the value of the <AssessmentGradeLevel> element.
void	setAssessmentGradeLevel(GradeLevelCode code) Sets the value of the <AssessmentGradeLevel> child element.
void	setCreationDateTime(java.util.Calendar value) Sets the value of the <CreationDateTime> element.
void	setLEAInfoRefId(java.lang.String value) Sets the value of the <LEAInfoRefId> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setSchoolInfoRefId(java.lang.String value) Sets the value of the <SchoolInfoRefId> element.
void	setSectionInfoRefId(java.lang.String value) Sets the value of the <SectionInfoRefId> element.
void	setStaffPersonalRefId(java.lang.String value) Sets the value of the <StaffPersonalRefId> element.
void	setStudentGradeLevel(GradeLevel value) Sets the value of the <StudentGradeLevel> element.
void	setStudentGradeLevel(GradeLevelCode code) Sets the value of the <StudentGradeLevel> child element.
void	setStudentPersonalRefId(java.lang.String value) Sets the value of the StudentPersonalRefId attribute.
void	setStudentSpecialConditions(StudentSpecialConditions value) Sets the value of the <StudentSpecialConditions> 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

AssessmentRegistration

public AssessmentRegistration()

Constructor

AssessmentRegistration

public AssessmentRegistration(java.lang.String refId,
                              java.lang.String studentPersonalRefId,
                              java.lang.String assessmentAdministrationRefId)

Constructor that accepts values for all mandatory fields

Parameters:

refId - The GUID that uniquely identifies an instance of the object.

studentPersonalRefId - The student associated with the registration.

assessmentAdministrationRefId - The assessment administration associated with the registration.

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 GUID that uniquely identifies an instance of the object."

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 GUID that uniquely identifies an instance of the object."

Parameters:

value - A String object

Since:

2.0

getStudentPersonalRefId

public java.lang.String getStudentPersonalRefId()

Gets the value of the StudentPersonalRefId attribute.

The SIF specification defines the meaning of this attribute as: "The student associated with the registration."

Returns:

The StudentPersonalRefId attribute of this object.

Since:

2.0

setStudentPersonalRefId

public void setStudentPersonalRefId(java.lang.String value)

Sets the value of the StudentPersonalRefId attribute.

The SIF specification defines the meaning of this attribute as: "The student associated with the registration."

Parameters:

value - A String object

Since:

2.0

getAssessmentAdministrationRefId

public java.lang.String getAssessmentAdministrationRefId()

Gets the value of the AssessmentAdministrationRefId attribute.

The SIF specification defines the meaning of this attribute as: "The assessment administration associated with the registration."

Returns:

The AssessmentAdministrationRefId attribute of this object.

Since:

2.0

setAssessmentAdministrationRefId

public void setAssessmentAdministrationRefId(java.lang.String value)

Sets the value of the AssessmentAdministrationRefId attribute.

The SIF specification defines the meaning of this attribute as: "The assessment administration associated with the registration."

Parameters:

value - A String object

Since:

2.0

getCreationDateTime

public java.util.Calendar getCreationDateTime()

Gets the value of the <CreationDateTime> element.

The SIF specification defines the meaning of this element as: "Date/time assignment is made."

Returns:

The CreationDateTime element of this object.

Since:

2.0

setCreationDateTime

public void setCreationDateTime(java.util.Calendar value)

Sets the value of the <CreationDateTime> element.

The SIF specification defines the meaning of this element as: "Date/time assignment is made."

Parameters:

value - A Calendar object

Since:

2.0

setStudentSpecialConditions

public void setStudentSpecialConditions(StudentSpecialConditions value)

Sets the value of the <StudentSpecialConditions> element.

Parameters:

value - A StudentSpecialConditions object

Since:

2.0

getStudentSpecialConditions

public StudentSpecialConditions getStudentSpecialConditions()

Gets the value of the <StudentSpecialConditions> element.

Returns:

A StudentSpecialConditions object

Since:

2.0

removeStudentSpecialConditions

public void removeStudentSpecialConditions()

Removes the StudentSpecialConditions child element previously created by calling setStudentSpecialConditions

Since:

2.0

setStudentGradeLevel

public void setStudentGradeLevel(GradeLevel value)

Sets the value of the <StudentGradeLevel> element.

The SIF specification defines the meaning of this element as: "Grade level of the student at the time of testing."

Parameters:

value - A GradeLevel object

Since:

2.0

setStudentGradeLevel

public void setStudentGradeLevel(GradeLevelCode code)

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

Parameters:

code - Code representing the grade level.

Since:

2.0

getStudentGradeLevel

public GradeLevel getStudentGradeLevel()

Gets the value of the <StudentGradeLevel> element.

The SIF specification defines the meaning of this element as: "Grade level of the student at the time of testing."

Returns:

A GradeLevel object

Since:

2.0

removeStudentGradeLevel

public void removeStudentGradeLevel()

Removes the StudentGradeLevel child element previously created by calling setStudentGradeLevel

Since:

2.0

setAssessmentGradeLevel

public void setAssessmentGradeLevel(GradeLevel value)

Sets the value of the <AssessmentGradeLevel> element.

The SIF specification defines the meaning of this element as: "The grade or level at which the student is to be tested. This element should be omitted unless the student is being tested out-of-level."

Parameters:

value - A GradeLevel object

Since:

2.0

setAssessmentGradeLevel

public void setAssessmentGradeLevel(GradeLevelCode code)

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

Parameters:

code - Code representing the grade level.

Since:

2.0

getAssessmentGradeLevel

public GradeLevel getAssessmentGradeLevel()

Gets the value of the <AssessmentGradeLevel> element.

The SIF specification defines the meaning of this element as: "The grade or level at which the student is to be tested. This element should be omitted unless the student is being tested out-of-level."

Returns:

A GradeLevel object

Since:

2.0

removeAssessmentGradeLevel

public void removeAssessmentGradeLevel()

Removes the AssessmentGradeLevel child element previously created by calling setAssessmentGradeLevel

Since:

2.0

getLEAInfoRefId

public java.lang.String getLEAInfoRefId()

Gets the value of the <LEAInfoRefId> element.

The SIF specification defines the meaning of this element as: "Optional reference to a district associated with the registration."

Returns:

The LEAInfoRefId element of this object.

Since:

2.0

setLEAInfoRefId

public void setLEAInfoRefId(java.lang.String value)

Sets the value of the <LEAInfoRefId> element.

The SIF specification defines the meaning of this element as: "Optional reference to a district associated with the registration."

Parameters:

value - A String object

Since:

2.0

getSchoolInfoRefId

public java.lang.String getSchoolInfoRefId()

Gets the value of the <SchoolInfoRefId> element.

The SIF specification defines the meaning of this element as: "Optional reference to a school associated with the registration."

Returns:

The SchoolInfoRefId element of this object.

Since:

2.0

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: "Optional reference to a school associated with the registration."

Parameters:

value - A String object

Since:

2.0

getStaffPersonalRefId

public java.lang.String getStaffPersonalRefId()

Gets the value of the <StaffPersonalRefId> element.

The SIF specification defines the meaning of this element as: "Optional reference to a staff person associated with the registration."

Returns:

The StaffPersonalRefId element of this object.

Since:

2.0

setStaffPersonalRefId

public void setStaffPersonalRefId(java.lang.String value)

Sets the value of the <StaffPersonalRefId> element.

The SIF specification defines the meaning of this element as: "Optional reference to a staff person associated with the registration."

Parameters:

value - A String object

Since:

2.0

getSectionInfoRefId

public java.lang.String getSectionInfoRefId()

Gets the value of the <SectionInfoRefId> element.

The SIF specification defines the meaning of this element as: "Optional reference to a section (or class) associated with the registration."

Returns:

The SectionInfoRefId element of this object.

Since:

2.0

setSectionInfoRefId

public void setSectionInfoRefId(java.lang.String value)

Sets the value of the <SectionInfoRefId> element.

The SIF specification defines the meaning of this element as: "Optional reference to a section (or class) associated with the registration."

Parameters:

value - A String object

Since:

2.0