com.edustructures.sifworks.etranscripts
Class Courses

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<Course>
                  com.edustructures.sifworks.etranscripts.Courses

All Implemented Interfaces:

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

public class Courses
extends SIFKeyedList<Course>

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

Courses()
Constructor

Courses(Course course)
Constructor that accepts values for all mandatory fields

Method Summary

void	addCourse(MarkingPeriod markingPeriods) Adds a new <Course> repeatable element.
Course	getCourse(MarkingPeriods markingPeriods) Gets a Course object instance.
Course[]	getCourses() Gets all Course object instances.
void	removeCourse(MarkingPeriods markingPeriods) Removes a Course object instance.
void	setCourses(Course[] courses) Sets an array of Course 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

Courses

public Courses()

Constructor

Courses

public Courses(Course course)

Constructor that accepts values for all mandatory fields

Parameters:

course -

Method Detail

addCourse

public void addCourse(MarkingPeriod markingPeriods)

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

Parameters:

markingPeriods -

Since:

2.0

removeCourse

public void removeCourse(MarkingPeriods markingPeriods)

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

Parameters:

markingPeriods - Identifies the Course object to remove by its MarkingPeriods value

Since:

2.0

getCourse

public Course getCourse(MarkingPeriods markingPeriods)

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

Parameters:

markingPeriods - Identifies the Course object to return by its "MarkingPeriods" attribute value

Returns:

A Course object

Since:

2.0

getCourses

public Course[] getCourses()

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

Returns:

An array of Course objects

Since:

2.0

setCourses

public void setCourses(Course[] courses)

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

Since:

2.0