com.edustructures.sifworks.assessment
Class StudentScoreSet

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.assessment.StudentScoreSet
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class StudentScoreSet
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
StudentScoreSet()
          Constructor
StudentScoreSet(java.lang.String refId, AssessmentReportingMethod scoreMetric, java.lang.String assessmentAdministrationRefId, java.lang.String studentPersonalRefId)
          Constructor that accepts values for all mandatory fields
 
Method Summary
 java.lang.String getAssessmentAdministrationRefId()
          Gets the value of the AssessmentAdministrationRefId attribute.
 java.lang.String getAssessmentRegistrationRefId()
          Gets the value of the AssessmentRegistrationRefId attribute.
 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 getRefId()
          Gets the value of the RefId attribute.
 java.lang.String getScoreMetric()
          Gets the value of the ScoreMetric attribute.
 Scores getScores()
          Gets the value of the <Scores> element.
 java.lang.String getStudentPersonalRefId()
          Gets the value of the StudentPersonalRefId attribute.
 void removeScores()
          Removes the Scores child element previously created by calling setScores
 void setAssessmentAdministrationRefId(java.lang.String value)
          Sets the value of the AssessmentAdministrationRefId attribute.
 void setAssessmentRegistrationRefId(java.lang.String value)
          Sets the value of the AssessmentRegistrationRefId attribute.
 void setRefId(java.lang.String value)
          Sets the value of the RefId attribute.
 void setScoreMetric(AssessmentReportingMethod value)
          Sets the value of the ScoreMetric attribute.
 void setScoreMetric(java.lang.String value)
          Sets the value of the ScoreMetric attribute as a String.
 void setScores(Scores value)
          Sets the value of the <Scores> element.
 void setStudentPersonalRefId(java.lang.String value)
          Sets the value of the StudentPersonalRefId attribute.
 
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

StudentScoreSet

public StudentScoreSet()
Constructor


StudentScoreSet

public StudentScoreSet(java.lang.String refId,
                       AssessmentReportingMethod scoreMetric,
                       java.lang.String assessmentAdministrationRefId,
                       java.lang.String studentPersonalRefId)
Constructor that accepts values for all mandatory fields

Parameters:
refId - The GUID that uniquely identifies an instance of the object.
scoreMetric - The metric or scale used to report the score.
assessmentAdministrationRefId - The administration associated with this score set.
studentPersonalRefId - The student associated with the response set.
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

getScoreMetric

public java.lang.String getScoreMetric()
Gets the value of the ScoreMetric attribute.

The SIF specification defines the meaning of this attribute as: "The metric or scale used to report the score."

Returns:
The ScoreMetric attribute of this object.
Since:
2.0

setScoreMetric

public void setScoreMetric(AssessmentReportingMethod value)
Sets the value of the ScoreMetric attribute.

The SIF specification defines the meaning of this attribute as: "The metric or scale used to report the score."

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

setScoreMetric

public void setScoreMetric(java.lang.String value)
Sets the value of the ScoreMetric attribute as a String.

The SIF specification defines the meaning of this attribute as: "The metric or scale used to report the score."

Parameters:
value - The value as a String
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 administration associated with this score set."

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 administration associated with this score set."

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 response set."

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 response set."

Parameters:
value - A String object
Since:
2.0

getAssessmentRegistrationRefId

public java.lang.String getAssessmentRegistrationRefId()
Gets the value of the AssessmentRegistrationRefId attribute.

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

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

setAssessmentRegistrationRefId

public void setAssessmentRegistrationRefId(java.lang.String value)
Sets the value of the AssessmentRegistrationRefId attribute.

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

Parameters:
value - A String object
Since:
2.0

setScores

public void setScores(Scores value)
Sets the value of the <Scores> element.

Parameters:
value - A Scores object
Since:
2.0

getScores

public Scores getScores()
Gets the value of the <Scores> element.

Returns:
A Scores object
Since:
2.0

removeScores

public void removeScores()
Removes the Scores child element previously created by calling setScores

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.