com.edustructures.sifworks.student
Class CalendarSummary

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.student.CalendarSummary

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CalendarSummary
extends SIFDataObject

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

CalendarSummary()
Constructor

CalendarSummary(java.lang.String refId, java.lang.String schoolInfoRefId, java.lang.Integer schoolYear, java.lang.String localId, java.lang.Integer daysInSession)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.Integer	getDaysInSession() Gets the value of the <DaysInSession> element.
java.lang.String	getDescription() Gets the value of the <Description> element.
java.util.Calendar	getEndDate() Gets the value of the <EndDate> element.
java.util.Calendar	getFirstInstructionDate() Gets the value of the <FirstInstructionDate> element.
GradeLevels	getGradeLevels() Gets the value of the <GradeLevels> element.
PartialDateType	getGraduationDate() Gets the value of the <GraduationDate> element.
java.lang.Integer	getInstructionalMinutes() Gets the value of the <InstructionalMinutes> element.
java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
java.util.Calendar	getLastInstructionDate() Gets the value of the <LastInstructionDate> element.
java.lang.String	getLocalId() Gets the value of the <LocalId> element.
java.lang.Integer	getMinutesPerDay() Gets the value of the <MinutesPerDay> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
java.lang.String	getSchoolInfoRefId() Gets the value of the SchoolInfoRefId attribute.
java.lang.Integer	getSchoolYear() Gets the value of the SchoolYear attribute.
java.util.Calendar	getStartDate() Gets the value of the <StartDate> element.
void	removeGradeLevels() Removes the GradeLevels child element previously created by calling setGradeLevels
void	removeGraduationDate() Removes the GraduationDate child element previously created by calling setGraduationDate
void	setDaysInSession(java.lang.Integer value) Sets the value of the <DaysInSession> element.
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setEndDate(java.util.Calendar value) Sets the value of the <EndDate> element.
void	setFirstInstructionDate(java.util.Calendar value) Sets the value of the <FirstInstructionDate> element.
void	setGradeLevels(GradeLevels value) Sets the value of the <GradeLevels> element.
void	setGraduationDate(PartialDateType value) Sets the value of the <GraduationDate> element.
void	setGraduationDate(java.lang.String value) Sets the value of the <GraduationDate> child element.
void	setInstructionalMinutes(java.lang.Integer value) Sets the value of the <InstructionalMinutes> element.
void	setLastInstructionDate(java.util.Calendar value) Sets the value of the <LastInstructionDate> element.
void	setLocalId(java.lang.String value) Sets the value of the <LocalId> element.
void	setMinutesPerDay(java.lang.Integer value) Sets the value of the <MinutesPerDay> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setSchoolInfoRefId(java.lang.String value) Sets the value of the SchoolInfoRefId attribute.
void	setSchoolYear(java.lang.Integer value) Sets the value of the SchoolYear attribute.
void	setStartDate(java.util.Calendar value) Sets the value of the <StartDate> element.

Methods inherited from class com.edustructures.sifworks.SIFDataObject

addSIFExtendedElement, clone, getElementOrAttribute, getObjectTag, getObjectType, getSIFExtendedElement, getSIFExtendedElements, getSIFExtendedElementsContainer, getSIFMetadata, getSIFVersion, setElementOrAttribute, setElementOrAttribute, setElementOrAttribute, setSIFExtendedElements, setSIFExtendedElementsContainer, setSIFMetadata, setSIFVersion, toXML

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, 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

CalendarSummary

public CalendarSummary()

Constructor

CalendarSummary

public CalendarSummary(java.lang.String refId,
                       java.lang.String schoolInfoRefId,
                       java.lang.Integer schoolYear,
                       java.lang.String localId,
                       java.lang.Integer daysInSession)

Constructor that accepts values for all mandatory fields

Parameters:

refId - The ID (GUID) of the calendar to which this information relates.

schoolInfoRefId - The ID (GUID) of the school for which this calendar information is being reported.

schoolYear - School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2007" for the 2006-07 school year).

localId - The locally assigned identifier for this calendar.

daysInSession - The total number of days that the school was or is anticipated to be in session during the school year. Also included are days on which the education institution facility is closed and the student body as a whole is engaged in planned activities off-campus under the guidance and direction of staff members.

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

getRefId

public java.lang.String getRefId()

Gets the value of the RefId attribute.

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

Overrides:

getRefId in class SIFDataObject

Returns:

The RefId attribute of this object.

Since:

2.0

setRefId

public void setRefId(java.lang.String value)

Sets the value of the RefId attribute.

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

Parameters:

value - A String object

Since:

2.0

getSchoolInfoRefId

public java.lang.String getSchoolInfoRefId()

Gets the value of the SchoolInfoRefId attribute.

The SIF specification defines the meaning of this attribute as: "The ID (GUID) of the school for which this calendar information is being reported."

Returns:

The SchoolInfoRefId attribute of this object.

Since:

2.0

setSchoolInfoRefId

public void setSchoolInfoRefId(java.lang.String value)

Sets the value of the SchoolInfoRefId attribute.

The SIF specification defines the meaning of this attribute as: "The ID (GUID) of the school for which this calendar information is being reported."

Parameters:

value - A String object

Since:

2.0

getSchoolYear

public java.lang.Integer getSchoolYear()

Gets the value of the SchoolYear attribute.

The SIF specification defines the meaning of this attribute as: "School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2007" for the 2006-07 school year)."

Returns:

The SchoolYear attribute of this object.

Since:

2.0

setSchoolYear

public void setSchoolYear(java.lang.Integer value)

Sets the value of the SchoolYear attribute.

The SIF specification defines the meaning of this attribute as: "School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2007" for the 2006-07 school year)."

Parameters:

value - A Integer object

Since:

2.0

getLocalId

public java.lang.String getLocalId()

Gets the value of the <LocalId> element.

The SIF specification defines the meaning of this element as: "The locally assigned identifier for this calendar."

Returns:

The LocalId element of this object.

Since:

2.0

setLocalId

public void setLocalId(java.lang.String value)

Sets the value of the <LocalId> element.

The SIF specification defines the meaning of this element as: "The locally assigned identifier for this calendar."

Parameters:

value - A String object

Since:

2.0

getDescription

public java.lang.String getDescription()

Gets the value of the <Description> element.

The SIF specification defines the meaning of this element as: "Textual description of the school calendar."

Returns:

The Description element of this object.

Since:

2.0

setDescription

public void setDescription(java.lang.String value)

Sets the value of the <Description> element.

The SIF specification defines the meaning of this element as: "Textual description of the school calendar."

Parameters:

value - A String object

Since:

2.0

getDaysInSession

public java.lang.Integer getDaysInSession()

Gets the value of the <DaysInSession> element.

The SIF specification defines the meaning of this element as: "The total number of days that the school was or is anticipated to be in session during the school year. Also included are days on which the education institution facility is closed and the student body as a whole is engaged in planned activities off-campus under the guidance and direction of staff members."

Returns:

The DaysInSession element of this object.

Since:

2.0

setDaysInSession

public void setDaysInSession(java.lang.Integer value)

Sets the value of the <DaysInSession> element.

The SIF specification defines the meaning of this element as: "The total number of days that the school was or is anticipated to be in session during the school year. Also included are days on which the education institution facility is closed and the student body as a whole is engaged in planned activities off-campus under the guidance and direction of staff members."

Parameters:

value - A Integer object

Since:

2.0

getStartDate

public java.util.Calendar getStartDate()

Gets the value of the <StartDate> element.

The SIF specification defines the meaning of this element as: "The first calendar date, whether or not instruction was provided. If both CalendarSummary and CalendarDate objects are supported, StartDate must be the date of the first chronological instance of CalendarDate for the school's calendar."

Returns:

The StartDate element of this object.

Since:

2.0

setStartDate

public void setStartDate(java.util.Calendar value)

Sets the value of the <StartDate> element.

The SIF specification defines the meaning of this element as: "The first calendar date, whether or not instruction was provided. If both CalendarSummary and CalendarDate objects are supported, StartDate must be the date of the first chronological instance of CalendarDate for the school's calendar."

Parameters:

value - A Calendar object

Since:

2.0

getEndDate

public java.util.Calendar getEndDate()

Gets the value of the <EndDate> element.

The SIF specification defines the meaning of this element as: "The last calendar date, whether or not instruction was provided. If both CalendarSummary and CalendarDate objects are supported, EndDate must be the last chronological instance of CalendarDate for the school's calendar."

Returns:

The EndDate element of this object.

Since:

2.0

setEndDate

public void setEndDate(java.util.Calendar value)

Sets the value of the <EndDate> element.

The SIF specification defines the meaning of this element as: "The last calendar date, whether or not instruction was provided. If both CalendarSummary and CalendarDate objects are supported, EndDate must be the last chronological instance of CalendarDate for the school's calendar."

Parameters:

value - A Calendar object

Since:

2.0

getFirstInstructionDate

public java.util.Calendar getFirstInstructionDate()

Gets the value of the <FirstInstructionDate> element.

The SIF specification defines the meaning of this element as: "The first day of student instruction."

Returns:

The FirstInstructionDate element of this object.

Since:

2.0

setFirstInstructionDate

public void setFirstInstructionDate(java.util.Calendar value)

Sets the value of the <FirstInstructionDate> element.

The SIF specification defines the meaning of this element as: "The first day of student instruction."

Parameters:

value - A Calendar object

Since:

2.0

getLastInstructionDate

public java.util.Calendar getLastInstructionDate()

Gets the value of the <LastInstructionDate> element.

The SIF specification defines the meaning of this element as: "The last day of student instruction (including days or times that students are present for purposes of testing and/or evaluation, but not including whole or part-days whose sole purposes is for distribution of report cards)."

Returns:

The LastInstructionDate element of this object.

Since:

2.0

setLastInstructionDate

public void setLastInstructionDate(java.util.Calendar value)

Sets the value of the <LastInstructionDate> element.

The SIF specification defines the meaning of this element as: "The last day of student instruction (including days or times that students are present for purposes of testing and/or evaluation, but not including whole or part-days whose sole purposes is for distribution of report cards)."

Parameters:

value - A Calendar object

Since:

2.0

setGraduationDate

public void setGraduationDate(PartialDateType value)

Sets the value of the <GraduationDate> element.

The SIF specification defines the meaning of this element as: "Date of graduation ceremony."

Parameters:

value - A PartialDateType object

Since:

2.0

setGraduationDate

public void setGraduationDate(java.lang.String value)

Sets the value of the <GraduationDate> child element. This form of setGraduationDate is provided as a convenience method that is functionally equivalent to the version of setGraduationDate that accepts a single PartialDateType object.

Parameters:

value - Gets or sets the content value of the <PartialDateType> element

Since:

2.0

getGraduationDate

public PartialDateType getGraduationDate()

Gets the value of the <GraduationDate> element.

The SIF specification defines the meaning of this element as: "Date of graduation ceremony."

Returns:

A PartialDateType object

Since:

2.0

removeGraduationDate

public void removeGraduationDate()

Removes the GraduationDate child element previously created by calling setGraduationDate

Since:

2.0

getInstructionalMinutes

public java.lang.Integer getInstructionalMinutes()

Gets the value of the <InstructionalMinutes> element.

The SIF specification defines the meaning of this element as: "The total number of instructional minutes for this calendar for the school year."

Returns:

The InstructionalMinutes element of this object.

Since:

2.0

setInstructionalMinutes

public void setInstructionalMinutes(java.lang.Integer value)

Sets the value of the <InstructionalMinutes> element.

The SIF specification defines the meaning of this element as: "The total number of instructional minutes for this calendar for the school year."

Parameters:

value - A Integer object

Since:

2.0

getMinutesPerDay

public java.lang.Integer getMinutesPerDay()

Gets the value of the <MinutesPerDay> element.

The SIF specification defines the meaning of this element as: "The number of minutes in the day in which the school is normally in session."

Returns:

The MinutesPerDay element of this object.

Since:

2.0

setMinutesPerDay

public void setMinutesPerDay(java.lang.Integer value)

Sets the value of the <MinutesPerDay> element.

The SIF specification defines the meaning of this element as: "The number of minutes in the day in which the school is normally in session."

Parameters:

value - A Integer object

Since:

2.0

setGradeLevels

public void setGradeLevels(GradeLevels value)

Sets the value of the <GradeLevels> element.

The SIF specification defines the meaning of this element as: "Collection of grade levels applicable to this school calendar."

Parameters:

value - A GradeLevels object

Since:

2.0

getGradeLevels

public GradeLevels getGradeLevels()

Gets the value of the <GradeLevels> element.

The SIF specification defines the meaning of this element as: "Collection of grade levels applicable to this school calendar."

Returns:

A GradeLevels object

Since:

2.0

removeGradeLevels

public void removeGradeLevels()

Removes the GradeLevels child element previously created by calling setGradeLevels

Since:

2.0