com.edustructures.sifworks.student
Class ScheduleInfoOverrideList

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<ScheduleInfoOverride>
              com.edustructures.sifworks.student.ScheduleInfoOverrideList

All Implemented Interfaces:

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

public class ScheduleInfoOverrideList
extends SIFList<ScheduleInfoOverride>

Since:

1.1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

ScheduleInfoOverrideList()
Constructor

ScheduleInfoOverrideList(ScheduleInfoOverride scheduleInfoOverride)
Constructor that accepts values for all mandatory fields

Method Summary

void	addScheduleInfoOverride(YesNo override, java.lang.String termInfoRefId) Adds a new <ScheduleInfoOverride> repeatable element.
ScheduleInfoOverride	getScheduleInfoOverride(YesNo override, java.lang.String termInfoRefId) Gets a ScheduleInfoOverride object instance.
ScheduleInfoOverride[]	getScheduleInfoOverrides() Gets all ScheduleInfoOverride object instances.
void	removeScheduleInfoOverride(YesNo override, java.lang.String termInfoRefId) Removes a ScheduleInfoOverride object instance.
void	setScheduleInfoOverrides(ScheduleInfoOverride[] scheduleinfooverrides) Sets an array of ScheduleInfoOverride objects.

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, 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

ScheduleInfoOverrideList

public ScheduleInfoOverrideList()

Constructor

ScheduleInfoOverrideList

public ScheduleInfoOverrideList(ScheduleInfoOverride scheduleInfoOverride)

Constructor that accepts values for all mandatory fields

Parameters:

scheduleInfoOverride - A complete replacement of the ScheduleInfo of the section for this student; this should be a subset of the schedule information for the section

Method Detail

addScheduleInfoOverride

public void addScheduleInfoOverride(YesNo override,
                                    java.lang.String termInfoRefId)

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

Parameters:

override - Designates whether or not scheduling information has been overridden with different values for this student.

termInfoRefId - The ID (GUID) of the term to which this override information relates for this student.

Since:

1.1

removeScheduleInfoOverride

public void removeScheduleInfoOverride(YesNo override,
                                       java.lang.String termInfoRefId)

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

Parameters:

override - Identifies the ScheduleInfoOverride object to remove by its Override value

termInfoRefId - Identifies the ScheduleInfoOverride object to remove by its TermInfoRefId value

Since:

1.1

getScheduleInfoOverride

public ScheduleInfoOverride getScheduleInfoOverride(YesNo override,
                                                    java.lang.String termInfoRefId)

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

Parameters:

override - Identifies the ScheduleInfoOverride object to return by its "Override" attribute value

termInfoRefId - Identifies the ScheduleInfoOverride object to return by its "TermInfoRefId" attribute value

Returns:

A ScheduleInfoOverride object

Since:

1.1

getScheduleInfoOverrides

public ScheduleInfoOverride[] getScheduleInfoOverrides()

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

Returns:

An array of ScheduleInfoOverride objects

Since:

1.1

setScheduleInfoOverrides

public void setScheduleInfoOverrides(ScheduleInfoOverride[] scheduleinfooverrides)

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

Since:

1.1