com.edustructures.sifworks.instr
Class SubjectAreas

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<SubjectArea>
                  com.edustructures.sifworks.instr.SubjectAreas

All Implemented Interfaces:

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

public class SubjectAreas
extends SIFKeyedList<SubjectArea>

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

SubjectAreas()
Constructor

SubjectAreas(SubjectArea subjectArea)
Constructor that accepts values for all mandatory fields

Method Summary

void	addSubjectArea(java.lang.String code) Adds a new <SubjectArea> repeatable element.
SubjectArea	getSubjectArea(java.lang.String code) Gets a SubjectArea object instance.
SubjectArea[]	getSubjectAreas() Gets all SubjectArea object instances.
void	removeSubjectArea(java.lang.String code) Removes a SubjectArea object instance.
void	setSubjectAreas(SubjectArea[] subjectareas) Sets an array of SubjectArea 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

SubjectAreas

public SubjectAreas()

Constructor

SubjectAreas

public SubjectAreas(SubjectArea subjectArea)

Constructor that accepts values for all mandatory fields

Parameters:

subjectArea -

Method Detail

addSubjectArea

public void addSubjectArea(java.lang.String code)

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

Parameters:

code - The subject area code (i.e. the first two digits of the course classification code)

Since:

2.0

removeSubjectArea

public void removeSubjectArea(java.lang.String code)

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

Parameters:

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

Since:

2.0

getSubjectArea

public SubjectArea getSubjectArea(java.lang.String code)

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

Parameters:

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

Returns:

A SubjectArea object

Since:

2.0

getSubjectAreas

public SubjectArea[] getSubjectAreas()

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

Returns:

An array of SubjectArea objects

Since:

2.0

setSubjectAreas

public void setSubjectAreas(SubjectArea[] subjectareas)

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

Since:

2.0