com.edustructures.sifworks.common
Class ExceptionalityCategories

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<ExceptionalityCategory>
                  com.edustructures.sifworks.common.ExceptionalityCategories

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<ExceptionalityCategory>, java.util.Collection<ExceptionalityCategory>

public class ExceptionalityCategories
extends SIFKeyedList<ExceptionalityCategory>

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

ExceptionalityCategories()
Constructor

ExceptionalityCategories(ExceptionalityCategory exceptionalityCategory)
Constructor that accepts values for all mandatory fields

Method Summary

void	addExceptionalityCategory(java.lang.String codeType, ExceptionalityPriority exceptionalityPriority, ExceptionalityCategoryCode code) Adds a new <ExceptionalityCategory> repeatable element.
ExceptionalityCategory	getExceptionalityCategory(ExceptionalityPriority exceptionalityPriority) Gets an ExceptionalityCategory object instance.
ExceptionalityCategory[]	getExceptionalityCategorys() Gets all ExceptionalityCategory object instances.
void	removeExceptionalityCategory(ExceptionalityPriority exceptionalityPriority) Removes an ExceptionalityCategory object instance.
void	setExceptionalityCategorys(ExceptionalityCategory[] exceptionalitycategorys) Sets an array of ExceptionalityCategory objects.

Methods inherited from class com.edustructures.sifworks.SIFKeyedList

getChild, getChild

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, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getKey, 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

ExceptionalityCategories

public ExceptionalityCategories()

Constructor

ExceptionalityCategories

public ExceptionalityCategories(ExceptionalityCategory exceptionalityCategory)

Constructor that accepts values for all mandatory fields

Parameters:

exceptionalityCategory -

Method Detail

addExceptionalityCategory

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

Adds a new <ExceptionalityCategory> repeatable element. This form of setExceptionalityCategory is provided as a convenience method that is functionally equivalent to the version of setExceptionalityCategory that accepts a single ExceptionalityCategory object.

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

Since:

2.0

removeExceptionalityCategory

public void removeExceptionalityCategory(ExceptionalityPriority exceptionalityPriority)

Removes an ExceptionalityCategory object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

exceptionalityPriority - Identifies the ExceptionalityCategory object to remove by its ExceptionalityPriority value

Since:

2.0

getExceptionalityCategory

public ExceptionalityCategory getExceptionalityCategory(ExceptionalityPriority exceptionalityPriority)

Gets an ExceptionalityCategory object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

exceptionalityPriority - Identifies the ExceptionalityCategory object to return by its "ExceptionalityPriority" attribute value

Returns:

An ExceptionalityCategory object

Since:

2.0

getExceptionalityCategorys

public ExceptionalityCategory[] getExceptionalityCategorys()

Gets all ExceptionalityCategory object instances. More than one instance can be defined for this object because it is a repeatable field element.

Returns:

An array of ExceptionalityCategory objects

Since:

2.0

setExceptionalityCategorys

public void setExceptionalityCategorys(ExceptionalityCategory[] exceptionalitycategorys)

Sets an array of ExceptionalityCategory objects. All existing ExceptionalityCategory instances are removed and replaced with this list. Calling this method with the parameter value set to null removes all ExceptionalityCategorys.

Since:

2.0