com.edustructures.sifworks.gradebook
Class GradingCategory

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

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

GradingCategory()
Constructor

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

Method Summary

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	getSectionInfoRefId() Gets the value of the SectionInfoRefId attribute.
java.lang.String	getTermInfoRefId() Gets the value of the TermInfoRefId attribute.
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	setSectionInfoRefId(java.lang.String value) Sets the value of the SectionInfoRefId 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, 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

GradingCategory

public GradingCategory()

Constructor

GradingCategory

public GradingCategory(java.lang.String refId,
                       java.lang.String sectionInfoRefId,
                       java.lang.String termInfoRefId,
                       java.lang.String schoolInfoRefId)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID that identifies a grading category.

sectionInfoRefId - The GUID for the SectionInfo object that this category is used for grading in.

termInfoRefId - The GUID for the TermInfo object that defines the marking period that the category was created 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

getRefId

public java.lang.String getRefId()

Gets the value of the RefId attribute.

The SIF specification defines the meaning of this attribute as: "GUID that identifies a grading category."

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: "GUID that identifies a grading category."

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 GUID for the SectionInfo object that this category is used for grading in."

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 GUID for the SectionInfo object that this category is used for grading in."

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 GUID for the TermInfo object that defines the marking period that the category was created 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 GUID for the TermInfo object that defines the marking period that the category was created 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

getDescription

public java.lang.String getDescription()

Gets the value of the <Description> element.

The SIF specification defines the meaning of this element as: "The name/short description of the category."

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: "The name/short description of the category."

Parameters:

value - A String object

Since:

2.0