com.edustructures.sifworks.common
Class ExceptionalityCategory

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.common.ExceptionalityCategory

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ExceptionalityCategory
extends SIFKeyedElement

Exceptionality description/code which will identify the exceptionality of the student. Not all programs require identification of an exceptionality. If required for this program type, must have at least one element with Type attribute = "Primary".

Since:

1.5r1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

ExceptionalityCategory()
Constructor

ExceptionalityCategory(java.lang.String codeType, ExceptionalityPriority exceptionalityPriority, ExceptionalityCategoryCode code)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getCode() Gets the value of the <Code> element.
java.lang.String	getCodeType() Gets the value of the CodeType attribute.
java.lang.String	getExceptionalityPriority() Gets the value of the ExceptionalityPriority 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
OtherCodeList	getOtherCodeList() Gets the value of the <OtherCodeList> element.
void	removeOtherCodeList() Removes the OtherCodeList child element previously created by calling setOtherCodeList
void	setCode(ExceptionalityCategoryCode value) Sets the value of the <Code> element.
void	setCode(java.lang.String value) Sets the value of the <Code> element as a String.
void	setCodeType(java.lang.String value) Sets the value of the CodeType attribute.
void	setExceptionalityPriority(ExceptionalityPriority value) Sets the value of the ExceptionalityPriority attribute.
void	setExceptionalityPriority(java.lang.String value) Sets the value of the ExceptionalityPriority attribute as a String.
void	setOtherCodeList(OtherCodeList value) Sets the value of the <OtherCodeList> element.

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

Constructor Detail

ExceptionalityCategory

public ExceptionalityCategory()

Constructor

ExceptionalityCategory

public ExceptionalityCategory(java.lang.String codeType,
                              ExceptionalityPriority exceptionalityPriority,
                              ExceptionalityCategoryCode code)

Constructor that accepts values for all mandatory fields

Parameters:

codeType - If CodeType = "NCES" then use code set 0768 Primary Disability Type [NCES Handbooks]

exceptionalityPriority - Identifies priority of the exceptionality. "Primary" is the first and is required even if only one exceptionality is specified. "Secondary", etc. are of lower priority. Primary, Secondary, and Tertiary must be specified before "Additional" is used.

code - Exceptionality description/code which identifies the exceptionality or areas of need of the student. Not all programs require identification of an exceptionality. If required for this program type, must have at least one element with ExceptionalityPriority attribute = "Primary".

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

getCodeType

public java.lang.String getCodeType()

Gets the value of the CodeType attribute.

The SIF specification defines the meaning of this attribute as: "If CodeType = "NCES" then use code set 0768 Primary Disability Type [NCES Handbooks]"

Returns:

The CodeType attribute of this object.

Since:

1.5r1

setCodeType

public void setCodeType(java.lang.String value)

Sets the value of the CodeType attribute.

The SIF specification defines the meaning of this attribute as: "If CodeType = "NCES" then use code set 0768 Primary Disability Type [NCES Handbooks]"

Parameters:

value - A String object

Since:

1.5r1

getExceptionalityPriority

public java.lang.String getExceptionalityPriority()

Gets the value of the ExceptionalityPriority attribute.

The SIF specification defines the meaning of this attribute as: "Identifies priority of the exceptionality. "Primary" is the first and is required even if only one exceptionality is specified. "Secondary", etc. are of lower priority. Primary, Secondary, and Tertiary must be specified before "Additional" is used."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.5r1	"Type"
SIF2.0	"ExceptionalityPriority"

Returns:

The ExceptionalityPriority attribute of this object.

Since:

1.5r1

setExceptionalityPriority

public void setExceptionalityPriority(ExceptionalityPriority value)

Sets the value of the ExceptionalityPriority attribute.

The SIF specification defines the meaning of this attribute as: "Identifies priority of the exceptionality. "Primary" is the first and is required even if only one exceptionality is specified. "Secondary", etc. are of lower priority. Primary, Secondary, and Tertiary must be specified before "Additional" is used."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.5r1	"Type"
SIF2.0	"ExceptionalityPriority"

Parameters:

value - A constant defined by the ExceptionalityPriority class

Since:

1.5r1

setExceptionalityPriority

public void setExceptionalityPriority(java.lang.String value)

Sets the value of the ExceptionalityPriority attribute as a String.

The SIF specification defines the meaning of this attribute as: "Identifies priority of the exceptionality. "Primary" is the first and is required even if only one exceptionality is specified. "Secondary", etc. are of lower priority. Primary, Secondary, and Tertiary must be specified before "Additional" is used."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.5r1	"Type"
SIF2.0	"ExceptionalityPriority"

Parameters:

value - The value as a String

Since:

1.5r1

setOtherCodeList

public void setOtherCodeList(OtherCodeList value)

Sets the value of the <OtherCodeList> element.

Parameters:

value - A OtherCodeList object

Since:

2.0

getOtherCodeList

public OtherCodeList getOtherCodeList()

Gets the value of the <OtherCodeList> element.

Returns:

An OtherCodeList object

Since:

2.0

removeOtherCodeList

public void removeOtherCodeList()

Removes the OtherCodeList child element previously created by calling setOtherCodeList

Since:

2.0

getCode

public java.lang.String getCode()

Gets the value of the <Code> element.

The SIF specification defines the meaning of this element as: "Exceptionality description/code which identifies the exceptionality or areas of need of the student. Not all programs require identification of an exceptionality. If required for this program type, must have at least one element with ExceptionalityPriority attribute = "Primary"."

Returns:

The Code element of this object.

Since:

1.5r1

setCode

public void setCode(ExceptionalityCategoryCode value)

Sets the value of the <Code> element.

The SIF specification defines the meaning of this element as: "Exceptionality description/code which identifies the exceptionality or areas of need of the student. Not all programs require identification of an exceptionality. If required for this program type, must have at least one element with ExceptionalityPriority attribute = "Primary"."

Parameters:

value - A constant defined by the ExceptionalityCategoryCode class

Since:

1.5r1

setCode

public void setCode(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "Exceptionality description/code which identifies the exceptionality or areas of need of the student. Not all programs require identification of an exceptionality. If required for this program type, must have at least one element with ExceptionalityPriority attribute = "Primary"."

Parameters:

value - The value as a String

Since:

1.5r1