com.edustructures.sifworks.student
Class CalendarDate

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CalendarDate
extends SIFDataObject

This object defines information related to a school calendar day in a given school calendar year. If both CalendarDate and CalendarSummary objects are supported, there must be an instance of this object for each date between CalendarSummary StartDate and EndDate, inclusive.

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

CalendarDate()
Constructor

CalendarDate(java.util.Calendar date, java.lang.String calendarSummaryRefId, java.lang.String schoolInfoRefId, java.lang.Integer schoolYear, CalendarDateType calendarDateType)
Constructor that accepts values for all mandatory fields

Method Summary

AdministratorAttendance	getAdministratorAttendance() Gets the value of the <AdministratorAttendance> element.
java.lang.Integer	getCalendarDateNumber() Gets the value of the <CalendarDateNumber> element.
CalendarDateType	getCalendarDateType() Gets the value of the <CalendarDateType> element.
java.lang.String	getCalendarSummaryRefId() Gets the value of the CalendarSummaryRefId attribute.
java.util.Calendar	getDate() Gets the value of the Date attribute.
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.lang.String	getSchoolInfoRefId() Gets the value of the SchoolInfoRefId attribute.
java.lang.Integer	getSchoolYear() Gets the value of the SchoolYear attribute.
StudentAttendance	getStudentAttendance() Gets the value of the <StudentAttendance> element.
TeacherAttendance	getTeacherAttendance() Gets the value of the <TeacherAttendance> element.
void	removeAdministratorAttendance() Removes the AdministratorAttendance child element previously created by calling setAdministratorAttendance
void	removeCalendarDateType() Removes the CalendarDateType child element previously created by calling setCalendarDateType
void	removeStudentAttendance() Removes the StudentAttendance child element previously created by calling setStudentAttendance
void	removeTeacherAttendance() Removes the TeacherAttendance child element previously created by calling setTeacherAttendance
void	setAdministratorAttendance(AdministratorAttendance value) Sets the value of the <AdministratorAttendance> element.
void	setCalendarDateNumber(java.lang.Integer value) Sets the value of the <CalendarDateNumber> element.
void	setCalendarDateType(CalendarDateType value) Sets the value of the <CalendarDateType> element.
void	setCalendarSummaryRefId(java.lang.String value) Sets the value of the CalendarSummaryRefId attribute.
void	setDate(java.util.Calendar value) Sets the value of the Date 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	setStudentAttendance(StudentAttendance value) Sets the value of the <StudentAttendance> element.
void	setTeacherAttendance(TeacherAttendance value) Sets the value of the <TeacherAttendance> element.

Methods inherited from class com.edustructures.sifworks.SIFDataObject

addSIFExtendedElement, clone, getElementOrAttribute, getObjectTag, getObjectType, getRefId, 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

CalendarDate

public CalendarDate()

Constructor

CalendarDate

public CalendarDate(java.util.Calendar date,
                    java.lang.String calendarSummaryRefId,
                    java.lang.String schoolInfoRefId,
                    java.lang.Integer schoolYear,
                    CalendarDateType calendarDateType)

Constructor that accepts values for all mandatory fields

Parameters:

date - A specific school day that occurs within the school year.

calendarSummaryRefId - The ID (GUID) of the calendar summary in which this calendar date is.

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).

calendarDateType -

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

getDate

public java.util.Calendar getDate()

Gets the value of the Date attribute.

The SIF specification defines the meaning of this attribute as: "A specific school day that occurs within the school year."

Returns:

The Date attribute of this object.

Since:

2.0

setDate

public void setDate(java.util.Calendar value)

Sets the value of the Date attribute.

The SIF specification defines the meaning of this attribute as: "A specific school day that occurs within the school year."

Parameters:

value - A Calendar object

Since:

2.0

getCalendarSummaryRefId

public java.lang.String getCalendarSummaryRefId()

Gets the value of the CalendarSummaryRefId attribute.

The SIF specification defines the meaning of this attribute as: "The ID (GUID) of the calendar summary in which this calendar date is."

Returns:

The CalendarSummaryRefId attribute of this object.

Since:

2.0

setCalendarSummaryRefId

public void setCalendarSummaryRefId(java.lang.String value)

Sets the value of the CalendarSummaryRefId attribute.

The SIF specification defines the meaning of this attribute as: "The ID (GUID) of the calendar summary in which this calendar date is."

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

setCalendarDateType

public void setCalendarDateType(CalendarDateType value)

Sets the value of the <CalendarDateType> element.

Parameters:

value - A CalendarDateType object

Since:

2.0

getCalendarDateType

public CalendarDateType getCalendarDateType()

Gets the value of the <CalendarDateType> element.

Returns:

A CalendarDateType object

Since:

2.0

removeCalendarDateType

public void removeCalendarDateType()

Removes the CalendarDateType child element previously created by calling setCalendarDateType

Since:

2.0

getCalendarDateNumber

public java.lang.Integer getCalendarDateNumber()

Gets the value of the <CalendarDateNumber> element.

Returns:

The CalendarDateNumber element of this object.

Since:

2.0

setCalendarDateNumber

public void setCalendarDateNumber(java.lang.Integer value)

Sets the value of the <CalendarDateNumber> element.

Parameters:

value - A Integer object

Since:

2.0

setStudentAttendance

public void setStudentAttendance(StudentAttendance value)

Sets the value of the <StudentAttendance> element.

Parameters:

value - A StudentAttendance object

Since:

2.0

getStudentAttendance

public StudentAttendance getStudentAttendance()

Gets the value of the <StudentAttendance> element.

Returns:

A StudentAttendance object

Since:

2.0

removeStudentAttendance

public void removeStudentAttendance()

Removes the StudentAttendance child element previously created by calling setStudentAttendance

Since:

2.0

setTeacherAttendance

public void setTeacherAttendance(TeacherAttendance value)

Sets the value of the <TeacherAttendance> element.

Parameters:

value - A TeacherAttendance object

Since:

2.0

getTeacherAttendance

public TeacherAttendance getTeacherAttendance()

Gets the value of the <TeacherAttendance> element.

Returns:

A TeacherAttendance object

Since:

2.0

removeTeacherAttendance

public void removeTeacherAttendance()

Removes the TeacherAttendance child element previously created by calling setTeacherAttendance

Since:

2.0

setAdministratorAttendance

public void setAdministratorAttendance(AdministratorAttendance value)

Sets the value of the <AdministratorAttendance> element.

Parameters:

value - A AdministratorAttendance object

Since:

2.0

getAdministratorAttendance

public AdministratorAttendance getAdministratorAttendance()

Gets the value of the <AdministratorAttendance> element.

Returns:

An AdministratorAttendance object

Since:

2.0

removeAdministratorAttendance

public void removeAdministratorAttendance()

Removes the AdministratorAttendance child element previously created by calling setAdministratorAttendance

Since:

2.0