com.edustructures.sifworks.etranscripts
Class AssessmentPerformanceHistory

java.lang.Object
  extended by com.edustructures.sifworks.Element
      extended by com.edustructures.sifworks.SIFElement
          extended by com.edustructures.sifworks.SIFList<AssessmentHistory>
              extended by com.edustructures.sifworks.etranscripts.AssessmentPerformanceHistory
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<AssessmentHistory>, java.util.Collection<AssessmentHistory>

public class AssessmentPerformanceHistory
extends SIFList<AssessmentHistory>

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
AssessmentPerformanceHistory()
          Constructor
AssessmentPerformanceHistory(AssessmentHistory assessment)
          Constructor that accepts values for all mandatory fields
 
Method Summary
 void addAssessment(java.lang.String name, PartialDateType administrationDate, GradeLevel studentGradeLevelWhenAssessed, AssessmentReportingMethod testScoreType, java.lang.String testScore)
          Adds a new <Assessment> repeatable element.
 AssessmentHistory getAssessment(java.lang.String name, PartialDateType administrationDate, GradeLevel studentGradeLevelWhenAssessed, AssessmentReportingMethod testScoreType, java.lang.String testScore)
          Gets an AssessmentHistory object instance.
 AssessmentHistory[] getAssessments()
          Gets all AssessmentHistory object instances.
 java.lang.String getKey()
          Gets the key of this object
 ElementDef[] getKeyFields()
          Gets the metadata fields that make up the key of this object
 void removeAssessment(java.lang.String name, PartialDateType administrationDate, GradeLevel studentGradeLevelWhenAssessed, AssessmentReportingMethod testScoreType, java.lang.String testScore)
          Removes an AssessmentHistory object instance.
 void setAssessments(AssessmentHistory[] assessments)
          Sets an array of AssessmentHistory objects.
 
Methods inherited from class com.edustructures.sifworks.SIFList
add, addAll, clear, contains, containsAll, get, iterator, remove, remove, removeAll, retainAll, size, toArray, toArray
 
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
 
Methods inherited from interface java.util.Collection
equals, hashCode, isEmpty
 

Constructor Detail

AssessmentPerformanceHistory

public AssessmentPerformanceHistory()
Constructor


AssessmentPerformanceHistory

public AssessmentPerformanceHistory(AssessmentHistory assessment)
Constructor that accepts values for all mandatory fields

Parameters:
assessment -
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

addAssessment

public void addAssessment(java.lang.String name,
                          PartialDateType administrationDate,
                          GradeLevel studentGradeLevelWhenAssessed,
                          AssessmentReportingMethod testScoreType,
                          java.lang.String testScore)
Adds a new <Assessment> repeatable element. This form of setAssessment is provided as a convenience method that is functionally equivalent to the version of setAssessment that accepts a single AssessmentHistory object.

Parameters:
name - Textual description of assessment.
administrationDate - Date the assessment was administered.
studentGradeLevelWhenAssessed - Student's grade level when assessed.
testScoreType - Type of test score
testScore - Test score.
Since:
2.0

removeAssessment

public void removeAssessment(java.lang.String name,
                             PartialDateType administrationDate,
                             GradeLevel studentGradeLevelWhenAssessed,
                             AssessmentReportingMethod testScoreType,
                             java.lang.String testScore)
Removes an AssessmentHistory object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:
name - Identifies the AssessmentHistory object to remove by its Name value
administrationDate - Identifies the AssessmentHistory object to remove by its AdministrationDate value
studentGradeLevelWhenAssessed - Identifies the AssessmentHistory object to remove by its StudentGradeLevelWhenAssessed value
testScoreType - Identifies the AssessmentHistory object to remove by its TestScoreType value
testScore - Identifies the AssessmentHistory object to remove by its TestScore value
Since:
2.0

getAssessment

public AssessmentHistory getAssessment(java.lang.String name,
                                       PartialDateType administrationDate,
                                       GradeLevel studentGradeLevelWhenAssessed,
                                       AssessmentReportingMethod testScoreType,
                                       java.lang.String testScore)
Gets an AssessmentHistory object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:
name - Identifies the AssessmentHistory object to return by its "Name" attribute value
administrationDate - Identifies the AssessmentHistory object to return by its "AdministrationDate" attribute value
studentGradeLevelWhenAssessed - Identifies the AssessmentHistory object to return by its "StudentGradeLevelWhenAssessed" attribute value
testScoreType - Identifies the AssessmentHistory object to return by its "TestScoreType" attribute value
testScore - Identifies the AssessmentHistory object to return by its "TestScore" attribute value
Returns:
An AssessmentHistory object
Since:
2.0

getAssessments

public AssessmentHistory[] getAssessments()
Gets all AssessmentHistory object instances. More than one instance can be defined for this object because it is a repeatable field element.

Returns:
An array of AssessmentHistory objects
Since:
2.0

setAssessments

public void setAssessments(AssessmentHistory[] assessments)
Sets an array of AssessmentHistory objects. All existing AssessmentHistory instances are removed and replaced with this list. Calling this method with the parameter value set to null removes all AssessmentHistorys.

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.