com.edustructures.sifworks.common
Class GradeLevels

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<GradeLevel>
                  com.edustructures.sifworks.common.GradeLevels

All Implemented Interfaces:

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

public class GradeLevels
extends SIFKeyedList<GradeLevel>

This is a common element used to specify a collection of grade levels supported. It is used in SchoolInfo and assessment-related objects.

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

GradeLevels()
Constructor

GradeLevels(GradeLevel gradeLevel)
Constructor that accepts values for all mandatory fields

Method Summary

void	addGradeLevel(GradeLevelCode code) Adds a new <GradeLevel> repeatable element.
GradeLevel	getGradeLevel(GradeLevelCode code) Gets a GradeLevel object instance.
GradeLevel[]	getGradeLevels() Gets all GradeLevel object instances.
void	removeGradeLevel(GradeLevelCode code) Removes a GradeLevel object instance.
void	setGradeLevels(GradeLevel[] gradelevels) Sets an array of GradeLevel 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

GradeLevels

public GradeLevels()

Constructor

GradeLevels

public GradeLevels(GradeLevel gradeLevel)

Constructor that accepts values for all mandatory fields

Parameters:

gradeLevel - For a description of this element, see the common element GradeLevel.

Method Detail

addGradeLevel

public void addGradeLevel(GradeLevelCode code)

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

Parameters:

code - Code representing the grade level.

Since:

1.5r1

removeGradeLevel

public void removeGradeLevel(GradeLevelCode code)

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

Parameters:

code - Identifies the GradeLevel object to remove by its Code value

Since:

1.5r1

getGradeLevel

public GradeLevel getGradeLevel(GradeLevelCode code)

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

Parameters:

code - Identifies the GradeLevel object to return by its "Code" attribute value

Returns:

A GradeLevel object

Since:

1.5r1

getGradeLevels

public GradeLevel[] getGradeLevels()

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

Returns:

An array of GradeLevel objects

Since:

1.5r1

setGradeLevels

public void setGradeLevels(GradeLevel[] gradelevels)

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

Since:

1.5r1