com.edustructures.sifworks.gradebook
Class StudentSectionMarks

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

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

StudentSectionMarks()
Constructor

StudentSectionMarks(java.lang.String studentPersonalRefId, java.lang.String sectionInfoRefId, java.lang.String termInfoRefId, java.lang.String schoolInfoRefId)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.Boolean	getIsFinal() Gets the value of the <IsFinal> 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
MarkList	getMarkList() Gets the value of the <MarkList> element.
java.lang.String	getSchoolInfoRefId() Gets the value of the SchoolInfoRefId attribute.
java.lang.String	getSectionInfoRefId() Gets the value of the SectionInfoRefId attribute.
java.lang.String	getStudentPersonalRefId() Gets the value of the StudentPersonalRefId attribute.
java.lang.String	getTermInfoRefId() Gets the value of the TermInfoRefId attribute.
void	removeMarkList() Removes the MarkList child element previously created by calling setMarkList
void	setIsFinal(java.lang.Boolean value) Sets the value of the <IsFinal> element.
void	setMarkList(MarkList value) Sets the value of the <MarkList> element.
void	setSchoolInfoRefId(java.lang.String value) Sets the value of the SchoolInfoRefId attribute.
void	setSectionInfoRefId(java.lang.String value) Sets the value of the SectionInfoRefId attribute.
void	setStudentPersonalRefId(java.lang.String value) Sets the value of the StudentPersonalRefId attribute.
void	setTermInfoRefId(java.lang.String value) Sets the value of the TermInfoRefId attribute.

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

StudentSectionMarks

public StudentSectionMarks()

Constructor

StudentSectionMarks

public StudentSectionMarks(java.lang.String studentPersonalRefId,
                           java.lang.String sectionInfoRefId,
                           java.lang.String termInfoRefId,
                           java.lang.String schoolInfoRefId)

Constructor that accepts values for all mandatory fields

Parameters:

studentPersonalRefId - The ID (GUID) that uniquely identifies the StudentPersonal object that this item refers to.

sectionInfoRefId - The ID (GUID) that uniquely identifies the SectionInfo object that this item refers to.

termInfoRefId - The ID (GUID) that identifies the marking period that the following marks are recorded in.

schoolInfoRefId - The ID (GUID) that uniquely identifies the School that these Mark Values apply to.

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

getStudentPersonalRefId

public java.lang.String getStudentPersonalRefId()

Gets the value of the StudentPersonalRefId attribute.

The SIF specification defines the meaning of this attribute as: "The ID (GUID) that uniquely identifies the StudentPersonal object that this item refers to."

Returns:

The StudentPersonalRefId attribute of this object.

Since:

2.0

setStudentPersonalRefId

public void setStudentPersonalRefId(java.lang.String value)

Sets the value of the StudentPersonalRefId attribute.

The SIF specification defines the meaning of this attribute as: "The ID (GUID) that uniquely identifies the StudentPersonal object that this item refers to."

Parameters:

value - A String object

Since:

2.0

getSectionInfoRefId

public java.lang.String getSectionInfoRefId()

Gets the value of the SectionInfoRefId attribute.

The SIF specification defines the meaning of this attribute as: "The ID (GUID) that uniquely identifies the SectionInfo object that this item refers to."

Returns:

The SectionInfoRefId attribute of this object.

Since:

2.0

setSectionInfoRefId

public void setSectionInfoRefId(java.lang.String value)

Sets the value of the SectionInfoRefId attribute.

The SIF specification defines the meaning of this attribute as: "The ID (GUID) that uniquely identifies the SectionInfo object that this item refers to."

Parameters:

value - A String object

Since:

2.0

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) that identifies the marking period that the following marks are recorded in."

Returns:

The TermInfoRefId attribute of this object.

Since:

2.0

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) that identifies the marking period that the following marks are recorded in."

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) that uniquely identifies the School that these Mark Values apply to."

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) that uniquely identifies the School that these Mark Values apply to."

Parameters:

value - A String object

Since:

2.0

getIsFinal

public java.lang.Boolean getIsFinal()

Gets the value of the <IsFinal> element.

The SIF specification defines the meaning of this element as: "Indicates if the grades are "Final" from the perspective of the teacher or school. Does not mean that change events will not occur for this item."

Returns:

The IsFinal element of this object.

Since:

2.0

setIsFinal

public void setIsFinal(java.lang.Boolean value)

Sets the value of the <IsFinal> element.

The SIF specification defines the meaning of this element as: "Indicates if the grades are "Final" from the perspective of the teacher or school. Does not mean that change events will not occur for this item."

Parameters:

value - A Boolean object

Since:

2.0

setMarkList

public void setMarkList(MarkList value)

Sets the value of the <MarkList> element.

Parameters:

value - A MarkList object

Since:

2.0

getMarkList

public MarkList getMarkList()

Gets the value of the <MarkList> element.

Returns:

A MarkList object

Since:

2.0

removeMarkList

public void removeMarkList()

Removes the MarkList child element previously created by calling setMarkList

Since:

2.0