com.edustructures.sifworks.gradebook
Class OfficialStudentPeriodAttendance

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.gradebook.OfficialStudentPeriodAttendance

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class OfficialStudentPeriodAttendance
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

OfficialStudentPeriodAttendance()
Constructor

Method Summary

AttendanceCode	getAttendanceCode() Gets the value of the <AttendanceCode> element.
java.lang.String	getAttendanceComment() Gets the value of the <AttendanceComment> element.
AuditInfo	getAuditInfo() Gets the value of the <AuditInfo> element.
java.util.Calendar	getTimeIn() Gets the value of the <TimeIn> element.
java.util.Calendar	getTimeOut() Gets the value of the <TimeOut> element.
java.lang.String	getTimetablePeriod() Gets the value of the <TimetablePeriod> element.
void	removeAttendanceCode() Removes the AttendanceCode child element previously created by calling setAttendanceCode
void	removeAuditInfo() Removes the AuditInfo child element previously created by calling setAuditInfo
void	setAttendanceCode(AttendanceCode value) Sets the value of the <AttendanceCode> element.
void	setAttendanceCode(java.lang.String attendanceCodeInfoRefId, java.lang.String value) Sets the value of the <AttendanceCode> child element.
void	setAttendanceComment(java.lang.String value) Sets the value of the <AttendanceComment> element.
void	setAuditInfo(AuditInfo value) Sets the value of the <AuditInfo> element.
void	setTimeIn(java.util.Calendar value) Sets the value of the <TimeIn> element.
void	setTimeOut(java.util.Calendar value) Sets the value of the <TimeOut> element.
void	setTimetablePeriod(java.lang.String value) Sets the value of the <TimetablePeriod> 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, getKey, 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

OfficialStudentPeriodAttendance

public OfficialStudentPeriodAttendance()

Constructor

Method Detail

getTimetablePeriod

public java.lang.String getTimetablePeriod()

Gets the value of the <TimetablePeriod> element.

The SIF specification defines the meaning of this element as: "The period within which attendance is being reported, e.g. "4D". Conditional on the SectionInfo object having MeetingTime elements. If one or more are defined for the Section, this element is required."

Returns:

The TimetablePeriod element of this object.

Since:

2.0

setTimetablePeriod

public void setTimetablePeriod(java.lang.String value)

Sets the value of the <TimetablePeriod> element.

The SIF specification defines the meaning of this element as: "The period within which attendance is being reported, e.g. "4D". Conditional on the SectionInfo object having MeetingTime elements. If one or more are defined for the Section, this element is required."

Parameters:

value - A String object

Since:

2.0

getTimeIn

public java.util.Calendar getTimeIn()

Gets the value of the <TimeIn> element.

The SIF specification defines the meaning of this element as: "The time the student entered or returned to this class."

Returns:

The TimeIn element of this object.

Since:

2.0

setTimeIn

public void setTimeIn(java.util.Calendar value)

Sets the value of the <TimeIn> element.

The SIF specification defines the meaning of this element as: "The time the student entered or returned to this class."

Parameters:

value - A Calendar object

Since:

2.0

getTimeOut

public java.util.Calendar getTimeOut()

Gets the value of the <TimeOut> element.

The SIF specification defines the meaning of this element as: "The time the student left this class."

Returns:

The TimeOut element of this object.

Since:

2.0

setTimeOut

public void setTimeOut(java.util.Calendar value)

Sets the value of the <TimeOut> element.

The SIF specification defines the meaning of this element as: "The time the student left this class."

Parameters:

value - A Calendar object

Since:

2.0

setAttendanceCode

public void setAttendanceCode(AttendanceCode value)

Sets the value of the <AttendanceCode> element.

The SIF specification defines the meaning of this element as: "The local attendance code."

Parameters:

value - A AttendanceCode object

Since:

2.0

setAttendanceCode

public void setAttendanceCode(java.lang.String attendanceCodeInfoRefId,
                              java.lang.String value)

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

Parameters:

attendanceCodeInfoRefId - The ID (GUID) of the attendance code

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

Since:

2.0

getAttendanceCode

public AttendanceCode getAttendanceCode()

Gets the value of the <AttendanceCode> element.

The SIF specification defines the meaning of this element as: "The local attendance code."

Returns:

An AttendanceCode object

Since:

2.0

removeAttendanceCode

public void removeAttendanceCode()

Removes the AttendanceCode child element previously created by calling setAttendanceCode

Since:

2.0

setAuditInfo

public void setAuditInfo(AuditInfo value)

Sets the value of the <AuditInfo> element.

Parameters:

value - A AuditInfo object

Since:

2.0

getAuditInfo

public AuditInfo getAuditInfo()

Gets the value of the <AuditInfo> element.

Returns:

An AuditInfo object

Since:

2.0

removeAuditInfo

public void removeAuditInfo()

Removes the AuditInfo child element previously created by calling setAuditInfo

Since:

2.0

getAttendanceComment

public java.lang.String getAttendanceComment()

Gets the value of the <AttendanceComment> element.

The SIF specification defines the meaning of this element as: "This element contains the comments that are relevant to this attendance record."

Returns:

The AttendanceComment element of this object.

Since:

2.0

setAttendanceComment

public void setAttendanceComment(java.lang.String value)

Sets the value of the <AttendanceComment> element.

The SIF specification defines the meaning of this element as: "This element contains the comments that are relevant to this attendance record."

Parameters:

value - A String object

Since:

2.0