com.edustructures.sifworks.assessment
Class AssessmentForm

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

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

AssessmentForm()
Constructor

AssessmentForm(java.lang.String refId, java.lang.String assessmentRefId)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getAssessmentRefId() Gets the value of the AssessmentRefId attribute.
AssessmentSubTestRefIds	getAssessmentSubTestRefIds() Gets the value of the <AssessmentSubTestRefIds> element.
java.lang.String	getAssessmentType() Gets the value of the <AssessmentType> element.
java.lang.String	getFormName() Gets the value of the <FormName> element.
FormNumbers	getFormNumbers() Gets the value of the <FormNumbers> element.
GradeLevels	getGradeLevels() Gets the value of the <GradeLevels> 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	getLevel() Gets the value of the <Level> element.
java.lang.String	getPeriod() Gets the value of the <Period> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
void	removeAssessmentSubTestRefIds() Removes the AssessmentSubTestRefIds child element previously created by calling setAssessmentSubTestRefIds
void	removeFormNumbers() Removes the FormNumbers child element previously created by calling setFormNumbers
void	removeGradeLevels() Removes the GradeLevels child element previously created by calling setGradeLevels
void	setAssessmentRefId(java.lang.String value) Sets the value of the AssessmentRefId attribute.
void	setAssessmentSubTestRefIds(AssessmentSubTestRefIds value) Sets the value of the <AssessmentSubTestRefIds> element.
void	setAssessmentType(AssessmentType value) Sets the value of the <AssessmentType> element.
void	setAssessmentType(java.lang.String value) Sets the value of the <AssessmentType> element as a String.
void	setFormName(java.lang.String value) Sets the value of the <FormName> element.
void	setFormNumbers(FormNumbers value) Sets the value of the <FormNumbers> element.
void	setGradeLevels(GradeLevels value) Sets the value of the <GradeLevels> element.
void	setLevel(java.lang.String value) Sets the value of the <Level> element.
void	setPeriod(java.lang.String value) Sets the value of the <Period> element.
void	setRefId(java.lang.String value) Sets the value of the RefId 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

AssessmentForm

public AssessmentForm()

Constructor

AssessmentForm

public AssessmentForm(java.lang.String refId,
                      java.lang.String assessmentRefId)

Constructor that accepts values for all mandatory fields

Parameters:

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

assessmentRefId - The RefId of the assessment related to this form.

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

getAssessmentRefId

public java.lang.String getAssessmentRefId()

Gets the value of the AssessmentRefId attribute.

The SIF specification defines the meaning of this attribute as: "The RefId of the assessment related to this form."

Returns:

The AssessmentRefId attribute of this object.

Since:

2.0

setAssessmentRefId

public void setAssessmentRefId(java.lang.String value)

Sets the value of the AssessmentRefId attribute.

The SIF specification defines the meaning of this attribute as: "The RefId of the assessment related to this form."

Parameters:

value - A String object

Since:

2.0

getAssessmentType

public java.lang.String getAssessmentType()

Gets the value of the <AssessmentType> element.

The SIF specification defines the meaning of this element as: "Indicates whether this assessment (form) is a standard administration or alternate."

Returns:

The AssessmentType element of this object.

Since:

2.0

setAssessmentType

public void setAssessmentType(AssessmentType value)

Sets the value of the <AssessmentType> element.

The SIF specification defines the meaning of this element as: "Indicates whether this assessment (form) is a standard administration or alternate."

Parameters:

value - A constant defined by the AssessmentType class

Since:

2.0

setAssessmentType

public void setAssessmentType(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "Indicates whether this assessment (form) is a standard administration or alternate."

Parameters:

value - The value as a String

Since:

2.0

getFormName

public java.lang.String getFormName()

Gets the value of the <FormName> element.

The SIF specification defines the meaning of this element as: "Text description for this particular arrangement of questions, etc."

Returns:

The FormName element of this object.

Since:

2.0

setFormName

public void setFormName(java.lang.String value)

Sets the value of the <FormName> element.

The SIF specification defines the meaning of this element as: "Text description for this particular arrangement of questions, etc."

Parameters:

value - A String object

Since:

2.0

setFormNumbers

public void setFormNumbers(FormNumbers value)

Sets the value of the <FormNumbers> element.

Parameters:

value - A FormNumbers object

Since:

2.0

getFormNumbers

public FormNumbers getFormNumbers()

Gets the value of the <FormNumbers> element.

Returns:

A FormNumbers object

Since:

2.0

removeFormNumbers

public void removeFormNumbers()

Removes the FormNumbers child element previously created by calling setFormNumbers

Since:

2.0

getLevel

public java.lang.String getLevel()

Gets the value of the <Level> element.

The SIF specification defines the meaning of this element as: "Indicates the level of the form."

Returns:

The Level element of this object.

Since:

2.0

setLevel

public void setLevel(java.lang.String value)

Sets the value of the <Level> element.

The SIF specification defines the meaning of this element as: "Indicates the level of the form."

Parameters:

value - A String object

Since:

2.0

getPeriod

public java.lang.String getPeriod()

Gets the value of the <Period> element.

The SIF specification defines the meaning of this element as: "The time period in which the form is intended to be administered."

Returns:

The Period element of this object.

Since:

2.0

setPeriod

public void setPeriod(java.lang.String value)

Sets the value of the <Period> element.

The SIF specification defines the meaning of this element as: "The time period in which the form is intended to be administered."

Parameters:

value - A String object

Since:

2.0

setGradeLevels

public void setGradeLevels(GradeLevels value)

Sets the value of the <GradeLevels> element.

The SIF specification defines the meaning of this element as: "Grade levels this assessment is designed to evaluate."

Parameters:

value - A GradeLevels object

Since:

2.0

getGradeLevels

public GradeLevels getGradeLevels()

Gets the value of the <GradeLevels> element.

The SIF specification defines the meaning of this element as: "Grade levels this assessment is designed to evaluate."

Returns:

A GradeLevels object

Since:

2.0

removeGradeLevels

public void removeGradeLevels()

Removes the GradeLevels child element previously created by calling setGradeLevels

Since:

2.0

setAssessmentSubTestRefIds

public void setAssessmentSubTestRefIds(AssessmentSubTestRefIds value)

Sets the value of the <AssessmentSubTestRefIds> element.

Parameters:

value - A AssessmentSubTestRefIds object

Since:

2.0

getAssessmentSubTestRefIds

public AssessmentSubTestRefIds getAssessmentSubTestRefIds()

Gets the value of the <AssessmentSubTestRefIds> element.

Returns:

An AssessmentSubTestRefIds object

Since:

2.0

removeAssessmentSubTestRefIds

public void removeAssessmentSubTestRefIds()

Removes the AssessmentSubTestRefIds child element previously created by calling setAssessmentSubTestRefIds

Since:

2.0