com.edustructures.sifworks.student
Class AttendanceCodeInfo

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class AttendanceCodeInfo
extends SIFDataObject

This object is to provides information about a particular attendance code, allows applications to synchronize each other's attendance code tables, or to provide a dynamic list of attendance codes. SIF_Events are reported.

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

AttendanceCodeInfo()
Constructor

AttendanceCodeInfo(java.lang.String refId, java.lang.String schoolInfoRefId, AttendanceType attendanceType, AttendanceStatus attendanceStatus)
Constructor that accepts values for all mandatory fields

Method Summary

java.math.BigDecimal	getAbsenceValue() Gets the value of the <AbsenceValue> element.
java.lang.String	getAttendanceCode() Gets the value of the <AttendanceCode> element.
java.lang.String	getAttendanceStatus() Gets the value of the <AttendanceStatus> element.
java.lang.String	getAttendanceType() Gets the value of the <AttendanceType> element.
java.math.BigDecimal	getAttendanceValue() Gets the value of the <AttendanceValue> element.
java.lang.String	getDescription() Gets the value of the <Description> 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.lang.String	getRefId() Gets the value of the RefId attribute.
java.lang.String	getSchoolInfoRefId() Gets the value of the SchoolInfoRefId attribute.
java.lang.String	getUsedForDailyAttendance() Gets the value of the <UsedForDailyAttendance> element.
java.lang.String	getUsedForPeriodAttendance() Gets the value of the <UsedForPeriodAttendance> element.
void	setAbsenceValue(java.math.BigDecimal value) Sets the value of the <AbsenceValue> element.
void	setAttendanceCode(java.lang.String value) Sets the value of the <AttendanceCode> element.
void	setAttendanceStatus(AttendanceStatus value) Sets the value of the <AttendanceStatus> element.
void	setAttendanceStatus(java.lang.String value) Sets the value of the <AttendanceStatus> element as a String.
void	setAttendanceType(AttendanceType value) Sets the value of the <AttendanceType> element.
void	setAttendanceType(java.lang.String value) Sets the value of the <AttendanceType> element as a String.
void	setAttendanceValue(java.math.BigDecimal value) Sets the value of the <AttendanceValue> element.
void	setDescription(java.lang.String value) Sets the value of the <Description> 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	setUsedForDailyAttendance(java.lang.String value) Sets the value of the <UsedForDailyAttendance> element as a String.
void	setUsedForDailyAttendance(YesNo value) Sets the value of the <UsedForDailyAttendance> element.
void	setUsedForPeriodAttendance(java.lang.String value) Sets the value of the <UsedForPeriodAttendance> element as a String.
void	setUsedForPeriodAttendance(YesNo value) Sets the value of the <UsedForPeriodAttendance> 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

AttendanceCodeInfo

public AttendanceCodeInfo()

Constructor

AttendanceCodeInfo

public AttendanceCodeInfo(java.lang.String refId,
                          java.lang.String schoolInfoRefId,
                          AttendanceType attendanceType,
                          AttendanceStatus attendanceStatus)

Constructor that accepts values for all mandatory fields

Parameters:

refId - The ID (GUID) that uniquely identifies this AttendanceCodeInfo entity.

schoolInfoRefId - The ID (GUID) that identifies the school where the attendance code is used.

attendanceType - Type of attendance code.

attendanceStatus - Excused status of the attendance code.

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) that uniquely identifies this AttendanceCodeInfo entity."

Overrides:

getRefId in class SIFDataObject

Returns:

The RefId attribute of this object.

Since:

1.1

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) that uniquely identifies this AttendanceCodeInfo entity."

Parameters:

value - A String object

Since:

1.1

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) that identifies the school where the attendance code is used."

Returns:

The SchoolInfoRefId attribute of this object.

Since:

1.1

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) that identifies the school where the attendance code is used."

Parameters:

value - A String object

Since:

1.1

getAttendanceCode

public java.lang.String getAttendanceCode()

Gets the value of the <AttendanceCode> element.

The SIF specification defines the meaning of this element as: "Locally defined code for attendance."

Returns:

The AttendanceCode element of this object.

Since:

1.1

setAttendanceCode

public void setAttendanceCode(java.lang.String value)

Sets the value of the <AttendanceCode> element.

The SIF specification defines the meaning of this element as: "Locally defined code for attendance."

Parameters:

value - A String object

Since:

1.1

getAttendanceType

public java.lang.String getAttendanceType()

Gets the value of the <AttendanceType> element.

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

Returns:

The AttendanceType element of this object.

Since:

1.1

setAttendanceType

public void setAttendanceType(AttendanceType value)

Sets the value of the <AttendanceType> element.

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

Parameters:

value - A constant defined by the AttendanceType class

Since:

1.1

setAttendanceType

public void setAttendanceType(java.lang.String value)

Sets the value of the <AttendanceType> element as a String.

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

Parameters:

value - The value as a String

Since:

1.1

getAttendanceStatus

public java.lang.String getAttendanceStatus()

Gets the value of the <AttendanceStatus> element.

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

Returns:

The AttendanceStatus element of this object.

Since:

1.1

setAttendanceStatus

public void setAttendanceStatus(AttendanceStatus value)

Sets the value of the <AttendanceStatus> element.

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

Parameters:

value - A constant defined by the AttendanceStatus class

Since:

1.1

setAttendanceStatus

public void setAttendanceStatus(java.lang.String value)

Sets the value of the <AttendanceStatus> element as a String.

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

Parameters:

value - The value as a String

Since:

1.1

getDescription

public java.lang.String getDescription()

Gets the value of the <Description> element.

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

Returns:

The Description element of this object.

Since:

1.1

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: "The text description of the attendance code."

Parameters:

value - A String object

Since:

1.1

getAbsenceValue

public java.math.BigDecimal getAbsenceValue()

Gets the value of the <AbsenceValue> element.

The SIF specification defines the meaning of this element as: "The amoung of absense represented by AttendanceCode, up to trhee decimal places"

Returns:

The AbsenceValue element of this object.

Since:

2.0

setAbsenceValue

public void setAbsenceValue(java.math.BigDecimal value)

Sets the value of the <AbsenceValue> element.

The SIF specification defines the meaning of this element as: "The amoung of absense represented by AttendanceCode, up to trhee decimal places"

Parameters:

value - A BigDecimal object

Since:

2.0

getAttendanceValue

public java.math.BigDecimal getAttendanceValue()

Gets the value of the <AttendanceValue> element.

The SIF specification defines the meaning of this element as: "Portion of the attendance relative to the time span being reported (e.g., day, period, section), up to three decimal places. This element has been removed in SIF 2.0"

Returns:

The AttendanceValue element of this object.

Since:

1.5r1

setAttendanceValue

public void setAttendanceValue(java.math.BigDecimal value)

Sets the value of the <AttendanceValue> element.

The SIF specification defines the meaning of this element as: "Portion of the attendance relative to the time span being reported (e.g., day, period, section), up to three decimal places. This element has been removed in SIF 2.0"

Parameters:

value - A BigDecimal object

Since:

1.5r1

getUsedForDailyAttendance

public java.lang.String getUsedForDailyAttendance()

Gets the value of the <UsedForDailyAttendance> element.

The SIF specification defines the meaning of this element as: "Is this attendance code used for daily attendance?"

Returns:

The UsedForDailyAttendance element of this object.

Since:

2.0

setUsedForDailyAttendance

public void setUsedForDailyAttendance(YesNo value)

Sets the value of the <UsedForDailyAttendance> element.

The SIF specification defines the meaning of this element as: "Is this attendance code used for daily attendance?"

Parameters:

value - A constant defined by the YesNo class

Since:

2.0

setUsedForDailyAttendance

public void setUsedForDailyAttendance(java.lang.String value)

Sets the value of the <UsedForDailyAttendance> element as a String.

The SIF specification defines the meaning of this element as: "Is this attendance code used for daily attendance?"

Parameters:

value - The value as a String

Since:

2.0

getUsedForPeriodAttendance

public java.lang.String getUsedForPeriodAttendance()

Gets the value of the <UsedForPeriodAttendance> element.

The SIF specification defines the meaning of this element as: "Is this attendance code used for period attendance?"

Returns:

The UsedForPeriodAttendance element of this object.

Since:

2.0

setUsedForPeriodAttendance

public void setUsedForPeriodAttendance(YesNo value)

Sets the value of the <UsedForPeriodAttendance> element.

The SIF specification defines the meaning of this element as: "Is this attendance code used for period attendance?"

Parameters:

value - A constant defined by the YesNo class

Since:

2.0

setUsedForPeriodAttendance

public void setUsedForPeriodAttendance(java.lang.String value)

Sets the value of the <UsedForPeriodAttendance> element as a String.

The SIF specification defines the meaning of this element as: "Is this attendance code used for period attendance?"

Parameters:

value - The value as a String

Since:

2.0