Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.edustructures.sifworks.programs
Class TestAccommodation

java.lang.Object
  extended by com.edustructures.sifworks.Element
      extended by com.edustructures.sifworks.SIFElement
          extended by com.edustructures.sifworks.SIFDataObject
              extended by com.edustructures.sifworks.programs.TestAccommodation
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable
public class TestAccommodation
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
TestAccommodation()
          Constructor
TestAccommodation(java.lang.String refId)
          Constructor that accepts values for all mandatory fields
 
Method Summary
 java.util.Calendar getActualTestAdministrationDate()
          Gets the value of the <ActualTestAdministrationDate> element.
 java.lang.String getAssessmentRegistrationRefId()
          Gets the value of the <AssessmentRegistrationRefId> element.
 java.lang.String getAuthorizedActual()
          Gets the value of the <AuthorizedActual> 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 getLEAInfoRefId()
          Gets the value of the <LEAInfoRefId> element.
 java.lang.String getLocalId()
          Gets the value of the <LocalId> element.
 Name getName()
          Gets the value of the <Name> element.
 java.util.Calendar getPlannedTestAdministrationDate()
          Gets the value of the <PlannedTestAdministrationDate> 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 getStateDistrictId()
          Gets the value of the <StateDistrictId> element.
 java.lang.String getStateProvinceId()
          Gets the value of the <StateProvinceId> element.
 java.lang.String getStateSchoolId()
          Gets the value of the <StateSchoolId> element.
 java.lang.String getStudentPersonalRefId()
          Gets the value of the <StudentPersonalRefId> element.
 StudentProgramAccommodations getStudentProgramAccommodations()
          Gets the value of the <StudentProgramAccommodations> element.
 java.lang.String getTestAdministration()
          Gets the value of the <TestAdministration> element.
 java.lang.String getTestAdministrationDateRange()
          Gets the value of the <TestAdministrationDateRange> element.
 java.lang.String getTestGradeLevel()
          Gets the value of the <TestGradeLevel> element.
 java.lang.String getTestSubjectArea()
          Gets the value of the <TestSubjectArea> element.
 java.lang.String getTestType()
          Gets the value of the <TestType> element.
 void removeGradeLevel()
          Removes the GradeLevel child element previously created by calling setGradeLevel
 void removeName()
          Removes the Name child element previously created by calling setName
 void removeStudentProgramAccommodations()
          Removes the StudentProgramAccommodations child element previously created by calling setStudentProgramAccommodations
 void setActualTestAdministrationDate(java.util.Calendar value)
          Sets the value of the <ActualTestAdministrationDate> element.
 void setAssessmentRegistrationRefId(java.lang.String value)
          Sets the value of the <AssessmentRegistrationRefId> element.
 void setAuthorizedActual(AuthorizedActual value)
          Sets the value of the <AuthorizedActual> element.
 void setAuthorizedActual(java.lang.String value)
          Sets the value of the <AuthorizedActual> element as a String.
 void setGradeLevel(GradeLevel value)
          Sets the value of the <GradeLevel> element.
 void setGradeLevel(GradeLevelCode code)
          Sets the value of the <GradeLevel> child element.
 void setLEAInfoRefId(java.lang.String value)
          Sets the value of the <LEAInfoRefId> element.
 void setLocalId(java.lang.String value)
          Sets the value of the <LocalId> element.
 void setName(Name value)
          Sets the value of the <Name> element.
 void setName(NameType type, java.lang.String lastName, java.lang.String firstName)
          Sets the value of the <Name> child element.
 void setPlannedTestAdministrationDate(java.util.Calendar value)
          Sets the value of the <PlannedTestAdministrationDate> 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 setStateDistrictId(java.lang.String value)
          Sets the value of the <StateDistrictId> 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 setStateSchoolId(java.lang.String value)
          Sets the value of the <StateSchoolId> element.
 void setStudentPersonalRefId(java.lang.String value)
          Sets the value of the <StudentPersonalRefId> element.
 void setStudentProgramAccommodations(StudentProgramAccommodations value)
          Sets the value of the <StudentProgramAccommodations> element.
 void setTestAdministration(java.lang.String value)
          Sets the value of the <TestAdministration> element.
 void setTestAdministrationDateRange(java.lang.String value)
          Sets the value of the <TestAdministrationDateRange> element.
 void setTestGradeLevel(java.lang.String value)
          Sets the value of the <TestGradeLevel> element.
 void setTestSubjectArea(java.lang.String value)
          Sets the value of the <TestSubjectArea> element.
 void setTestType(java.lang.String value)
          Sets the value of the <TestType> element as a String.
 void setTestType(TestType value)
          Sets the value of the <TestType> 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

TestAccommodation

public TestAccommodation()
Constructor

TestAccommodation

public TestAccommodation(java.lang.String refId)
Constructor that accepts values for all mandatory fields

Parameters:
refId - Unique ID for this set of test accommodations required for a particular student who is participating in a special program and for whom this set of test accommodation(s) is recommended / prescribed for this test administration (specific subject area and level) in a specific special programs plan.
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: "Unique ID for this set of test accommodations required for a particular student who is participating in a special program and for whom this set of test accommodation(s) is recommended / prescribed for this test administration (specific subject area and level) in a specific special programs plan."

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: "Unique ID for this set of test accommodations required for a particular student who is participating in a special program and for whom this set of test accommodation(s) is recommended / prescribed for this test administration (specific subject area and level) in a specific special programs plan."

Parameters:
value - A String object
Since:
2.0

getStudentPersonalRefId

public java.lang.String getStudentPersonalRefId()
Gets the value of the <StudentPersonalRefId> element.

The SIF specification defines the meaning of this element as: "Reference to StudentPersonal object. Typically a vendor is allowed to receive a StatePrId or a StudentName, but not both together. The student must be identified by StudentPersonalRefId, or StudentName and LocalId, or StateStudentId."

Returns:
The StudentPersonalRefId element of this object.
Since:
2.0

setStudentPersonalRefId

public void setStudentPersonalRefId(java.lang.String value)
Sets the value of the <StudentPersonalRefId> element.

The SIF specification defines the meaning of this element as: "Reference to StudentPersonal object. Typically a vendor is allowed to receive a StatePrId or a StudentName, but not both together. The student must be identified by StudentPersonalRefId, or StudentName and LocalId, or StateStudentId."

Parameters:
value - A String object
Since:
2.0

setName

public void setName(Name value)
Sets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "The student's name as presented in StudentPersonal object, Name element with a Type of 02 (Current Legal Name). If Type 02 is not available, Type of 04 (Name of Record)"

Parameters:
value - A Name object
Since:
2.0

setName

public void setName(NameType type,
                    java.lang.String lastName,
                    java.lang.String firstName)
Sets the value of the <Name> child element. This form of setName is provided as a convenience method that is functionally equivalent to the version of setName that accepts a single Name object.

Parameters:
type - Code that specifies what type of name this is. If unsure, use 04.
lastName - The last name.
firstName - The first name.
Since:
2.0

getName

public Name getName()
Gets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "The student's name as presented in StudentPersonal object, Name element with a Type of 02 (Current Legal Name). If Type 02 is not available, Type of 04 (Name of Record)"

Returns:
A Name object
Since:
2.0

removeName

public void removeName()
Removes the Name child element previously created by calling setName

Since:
2.0

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 assigned identifier for this student."

Returns:
The LocalId element of this object.
Since:
2.0

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 assigned identifier for this student."

Parameters:
value - A String object
Since:
2.0

getStateProvinceId

public java.lang.String getStateProvinceId()
Gets the value of the <StateProvinceId> element.

The SIF specification defines the meaning of this element as: "Reference to the state code identifying the student in the StudentPersonal object, as of the date of the response."

Returns:
The StateProvinceId element of this object.
Since:
2.0

setStateProvinceId

public void setStateProvinceId(StatePrCode value)
Sets the value of the <StateProvinceId> element.

The SIF specification defines the meaning of this element as: "Reference to the state code identifying the student in the StudentPersonal object, as of the date of the response."

Parameters:
value - A constant defined by the StatePrCode class
Since:
2.0

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: "Reference to the state code identifying the student in the StudentPersonal object, as of the date of the response."

Parameters:
value - The value as a String
Since:
2.0

getStateDistrictId

public java.lang.String getStateDistrictId()
Gets the value of the <StateDistrictId> element.

The SIF specification defines the meaning of this element as: "Reference to State code (StatePrId for LEAInfo) for the student's district of enrollment as of the date of the response (optional because school might be independent)."

Returns:
The StateDistrictId element of this object.
Since:
2.0

setStateDistrictId

public void setStateDistrictId(java.lang.String value)
Sets the value of the <StateDistrictId> element.

The SIF specification defines the meaning of this element as: "Reference to State code (StatePrId for LEAInfo) for the student's district of enrollment as of the date of the response (optional because school might be independent)."

Parameters:
value - A String object
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: "The RefId for the district to which the student's home school of enrollment belongs as of the date of the response (optional because school might be independent)."

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: "The RefId for the district to which the student's home school of enrollment belongs as of the date of the response (optional because school might be independent)."

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: "The RefId for the student's home school of enrollment as of the date of the response."

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: "The RefId for the student's home school of enrollment as of the date of the response."

Parameters:
value - A String object
Since:
2.0

getStateSchoolId

public java.lang.String getStateSchoolId()
Gets the value of the <StateSchoolId> element.

The SIF specification defines the meaning of this element as: "Reference to State code (StatePrId for SchoolInfo) for student's home school of enrollment as of the date of the response (optional because state may not require)."

Returns:
The StateSchoolId element of this object.
Since:
2.0

setStateSchoolId

public void setStateSchoolId(java.lang.String value)
Sets the value of the <StateSchoolId> element.

The SIF specification defines the meaning of this element as: "Reference to State code (StatePrId for SchoolInfo) for student's home school of enrollment as of the date of the response (optional because state may not require)."

Parameters:
value - A String object
Since:
2.0

setGradeLevel

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

The SIF specification defines the meaning of this element as: "Code for the current actual grade placement of the student as of the date of the response from StudentSchoolEnrollment."

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.

The SIF specification defines the meaning of this element as: "Code for the current actual grade placement of the student as of the date of the response from StudentSchoolEnrollment."

Returns:
A GradeLevel object
Since:
2.0

removeGradeLevel

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

Since:
2.0

getAssessmentRegistrationRefId

public java.lang.String getAssessmentRegistrationRefId()
Gets the value of the <AssessmentRegistrationRefId> element.

The SIF specification defines the meaning of this element as: "RefId for the student's registration / assignment to take a particular test (test name, subject area, level, grade level, type) at a particular time or within a particular timeframe. An assessment may also be identified by omitting this element and specifying the whole set (TestAdministration, TestSubjectArea, TestGradeLevel, TestAdministrationDateRange or PlannedTestAdministrationDate, and TestType)."

Returns:
The AssessmentRegistrationRefId element of this object.
Since:
2.0

setAssessmentRegistrationRefId

public void setAssessmentRegistrationRefId(java.lang.String value)
Sets the value of the <AssessmentRegistrationRefId> element.

The SIF specification defines the meaning of this element as: "RefId for the student's registration / assignment to take a particular test (test name, subject area, level, grade level, type) at a particular time or within a particular timeframe. An assessment may also be identified by omitting this element and specifying the whole set (TestAdministration, TestSubjectArea, TestGradeLevel, TestAdministrationDateRange or PlannedTestAdministrationDate, and TestType)."

Parameters:
value - A String object
Since:
2.0

getTestAdministration

public java.lang.String getTestAdministration()
Gets the value of the <TestAdministration> element.

The SIF specification defines the meaning of this element as: "Abbreviated name of the test for which this set of accommodations is to be provided."

Returns:
The TestAdministration element of this object.
Since:
2.0

setTestAdministration

public void setTestAdministration(java.lang.String value)
Sets the value of the <TestAdministration> element.

The SIF specification defines the meaning of this element as: "Abbreviated name of the test for which this set of accommodations is to be provided."

Parameters:
value - A String object
Since:
2.0

getTestSubjectArea

public java.lang.String getTestSubjectArea()
Gets the value of the <TestSubjectArea> element.

The SIF specification defines the meaning of this element as: "Subject area of the test. Teachers may only supply this element, while a high-stakes test will supply the whole set (TestAdministration, TestSubjectArea, TestGradeLevel, TestAdministrationDateRange or PlannedTestAdministrationDate, and TestType)."

Returns:
The TestSubjectArea element of this object.
Since:
2.0

setTestSubjectArea

public void setTestSubjectArea(java.lang.String value)
Sets the value of the <TestSubjectArea> element.

The SIF specification defines the meaning of this element as: "Subject area of the test. Teachers may only supply this element, while a high-stakes test will supply the whole set (TestAdministration, TestSubjectArea, TestGradeLevel, TestAdministrationDateRange or PlannedTestAdministrationDate, and TestType)."

Parameters:
value - A String object
Since:
2.0

getTestGradeLevel

public java.lang.String getTestGradeLevel()
Gets the value of the <TestGradeLevel> element.

The SIF specification defines the meaning of this element as: "Grade level of the test."

Returns:
The TestGradeLevel element of this object.
Since:
2.0

setTestGradeLevel

public void setTestGradeLevel(java.lang.String value)
Sets the value of the <TestGradeLevel> element.

The SIF specification defines the meaning of this element as: "Grade level of the test."

Parameters:
value - A String object
Since:
2.0

getTestAdministrationDateRange

public java.lang.String getTestAdministrationDateRange()
Gets the value of the <TestAdministrationDateRange> element.

The SIF specification defines the meaning of this element as: "General date range of the test (e.g. "Spring 2005"). Date is identified by either TestAdministrationDateRange or PlannedTestAdministrationDate"

Returns:
The TestAdministrationDateRange element of this object.
Since:
2.0

setTestAdministrationDateRange

public void setTestAdministrationDateRange(java.lang.String value)
Sets the value of the <TestAdministrationDateRange> element.

The SIF specification defines the meaning of this element as: "General date range of the test (e.g. "Spring 2005"). Date is identified by either TestAdministrationDateRange or PlannedTestAdministrationDate"

Parameters:
value - A String object
Since:
2.0

getPlannedTestAdministrationDate

public java.util.Calendar getPlannedTestAdministrationDate()
Gets the value of the <PlannedTestAdministrationDate> element.

The SIF specification defines the meaning of this element as: "The date the test is planned to be administered. Should contain the most current known date (Date is needed in order to identify accommodations to be sent -- accommodations are date-dependent)."

Returns:
The PlannedTestAdministrationDate element of this object.
Since:
2.0

setPlannedTestAdministrationDate

public void setPlannedTestAdministrationDate(java.util.Calendar value)
Sets the value of the <PlannedTestAdministrationDate> element.

The SIF specification defines the meaning of this element as: "The date the test is planned to be administered. Should contain the most current known date (Date is needed in order to identify accommodations to be sent -- accommodations are date-dependent)."

Parameters:
value - A Calendar object
Since:
2.0

getTestType

public java.lang.String getTestType()
Gets the value of the <TestType> element.

The SIF specification defines the meaning of this element as: "Identifies whether the test the student is to take is a standard or alternate."

Returns:
The TestType element of this object.
Since:
2.0

setTestType

public void setTestType(TestType value)
Sets the value of the <TestType> element.

The SIF specification defines the meaning of this element as: "Identifies whether the test the student is to take is a standard or alternate."

Parameters:
value - A constant defined by the TestType class
Since:
2.0

setTestType

public void setTestType(java.lang.String value)
Sets the value of the <TestType> element as a String.

The SIF specification defines the meaning of this element as: "Identifies whether the test the student is to take is a standard or alternate."

Parameters:
value - The value as a String
Since:
2.0

getAuthorizedActual

public java.lang.String getAuthorizedActual()
Gets the value of the <AuthorizedActual> element.

The SIF specification defines the meaning of this element as: "Indicator - Identifies whether accommodations in this object are authorized or were actually used."

Returns:
The AuthorizedActual element of this object.
Since:
2.0

setAuthorizedActual

public void setAuthorizedActual(AuthorizedActual value)
Sets the value of the <AuthorizedActual> element.

The SIF specification defines the meaning of this element as: "Indicator - Identifies whether accommodations in this object are authorized or were actually used."

Parameters:
value - A constant defined by the AuthorizedActual class
Since:
2.0

setAuthorizedActual

public void setAuthorizedActual(java.lang.String value)
Sets the value of the <AuthorizedActual> element as a String.

The SIF specification defines the meaning of this element as: "Indicator - Identifies whether accommodations in this object are authorized or were actually used."

Parameters:
value - The value as a String
Since:
2.0

getActualTestAdministrationDate

public java.util.Calendar getActualTestAdministrationDate()
Gets the value of the <ActualTestAdministrationDate> element.

The SIF specification defines the meaning of this element as: "The date the test was actually administered."

Returns:
The ActualTestAdministrationDate element of this object.
Since:
2.0

setActualTestAdministrationDate

public void setActualTestAdministrationDate(java.util.Calendar value)
Sets the value of the <ActualTestAdministrationDate> element.

The SIF specification defines the meaning of this element as: "The date the test was actually administered."

Parameters:
value - A Calendar object
Since:
2.0

setStudentProgramAccommodations

public void setStudentProgramAccommodations(StudentProgramAccommodations value)
Sets the value of the <StudentProgramAccommodations> element.

Parameters:
value - A StudentProgramAccommodations object
Since:
2.0

getStudentProgramAccommodations

public StudentProgramAccommodations getStudentProgramAccommodations()
Gets the value of the <StudentProgramAccommodations> element.

Returns:
A StudentProgramAccommodations object
Since:
2.0

removeStudentProgramAccommodations

public void removeStudentProgramAccommodations()
Removes the StudentProgramAccommodations child element previously created by calling setStudentProgramAccommodations

Since:
2.0
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
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.