com.edustructures.sifworks.student
Class ScheduleInfoOverride

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.student.ScheduleInfoOverride

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ScheduleInfoOverride
extends SIFElement

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

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

ScheduleInfoOverride()
Constructor

ScheduleInfoOverride(YesNo override, java.lang.String termInfoRefId)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
MeetingTimeList	getMeetingTimeList() Gets the value of the <MeetingTimeList> element.
java.lang.String	getOverride() Gets the value of the Override attribute.
java.lang.String	getTermInfoRefId() Gets the value of the TermInfoRefId attribute.
void	removeMeetingTimeList() Removes the MeetingTimeList child element previously created by calling setMeetingTimeList
void	setMeetingTimeList(MeetingTimeList value) Sets the value of the <MeetingTimeList> element.
void	setOverride(java.lang.String value) Sets the value of the Override attribute as a String.
void	setOverride(YesNo value) Sets the value of the Override attribute.
void	setTermInfoRefId(java.lang.String value) Sets the value of the TermInfoRefId attribute.

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

Constructor Detail

ScheduleInfoOverride

public ScheduleInfoOverride()

Constructor

ScheduleInfoOverride

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

Constructor that accepts values for all mandatory fields

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.

Method Detail

getKey

public java.lang.String getKey()

Gets the key of this object

Overrides:

getKey in class SIFElement

Returns:

The value of the object's Mandatory or Required attribute. If an object has more than one such attribute, the key is a period- delimited concatenation of the attribute values in sequential order

getKeyFields

public ElementDef[] getKeyFields()

Gets the metadata fields that make up the key of this object

Returns:

an array of metadata fields that make up the object's key

getOverride

public java.lang.String getOverride()

Gets the value of the Override attribute.

The SIF specification defines the meaning of this attribute as: "Designates whether or not scheduling information has been overridden with different values for this student."

Returns:

The Override attribute of this object.

Since:

1.1

setOverride

public void setOverride(YesNo value)

Sets the value of the Override attribute.

The SIF specification defines the meaning of this attribute as: "Designates whether or not scheduling information has been overridden with different values for this student."

Parameters:

value - A constant defined by the YesNo class

Since:

1.1

setOverride

public void setOverride(java.lang.String value)

Sets the value of the Override attribute as a String.

The SIF specification defines the meaning of this attribute as: "Designates whether or not scheduling information has been overridden with different values for this student."

Parameters:

value - The value as a String

Since:

1.1

getTermInfoRefId

public java.lang.String getTermInfoRefId()

Gets the value of the TermInfoRefId attribute.

The SIF specification defines the meaning of this attribute as: "The ID (GUID) of the term to which this override information relates for this student."

Returns:

The TermInfoRefId attribute of this object.

Since:

1.1

setTermInfoRefId

public void setTermInfoRefId(java.lang.String value)

Sets the value of the TermInfoRefId attribute.

The SIF specification defines the meaning of this attribute as: "The ID (GUID) of the term to which this override information relates for this student."

Parameters:

value - A String object

Since:

1.1

setMeetingTimeList

public void setMeetingTimeList(MeetingTimeList value)

Sets the value of the <MeetingTimeList> element.

The SIF specification defines the meaning of this element as: "Time(s) this section meets for this student; this should be a subset of the meeting times for the section"

Parameters:

value - A MeetingTimeList object

Since:

1.1

getMeetingTimeList

public MeetingTimeList getMeetingTimeList()

Gets the value of the <MeetingTimeList> element.

The SIF specification defines the meaning of this element as: "Time(s) this section meets for this student; this should be a subset of the meeting times for the section"

Returns:

A MeetingTimeList object

Since:

1.1

removeMeetingTimeList

public void removeMeetingTimeList()

Removes the MeetingTimeList child element previously created by calling setMeetingTimeList

Since:

1.1