com.edustructures.sifworks.gradebook
Class GradingAssignment

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

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

GradingAssignment()
Constructor

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

Method Summary

java.util.Calendar	getCreateDate() Gets the value of the <CreateDate> element.
java.lang.String	getDescription() Gets the value of the <Description> element.
DetailedDescription	getDetailedDescription() Gets the value of the <DetailedDescription> element.
java.util.Calendar	getDueDate() Gets the value of the <DueDate> element.
java.lang.String	getGradingCategoryRefId() Gets the value of the GradingCategoryRefId 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.Integer	getPointsPossible() Gets the value of the <PointsPossible> element.
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.
java.math.BigDecimal	getWeight() Gets the value of the <Weight> element.
void	removeDetailedDescription() Removes the DetailedDescription child element previously created by calling setDetailedDescription
void	setCreateDate(java.util.Calendar value) Sets the value of the <CreateDate> element.
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setDetailedDescription(DetailedDescription value) Sets the value of the <DetailedDescription> element.
void	setDetailedDescription(DetailedDescriptionType type, java.lang.String value) Sets the value of the <DetailedDescription> child element.
void	setDueDate(java.util.Calendar value) Sets the value of the <DueDate> element.
void	setGradingCategoryRefId(java.lang.String value) Sets the value of the GradingCategoryRefId attribute.
void	setPointsPossible(java.lang.Integer value) Sets the value of the <PointsPossible> 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.
void	setWeight(java.math.BigDecimal value) Sets the value of the <Weight> 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

GradingAssignment

public GradingAssignment()

Constructor

GradingAssignment

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

Constructor that accepts values for all mandatory fields

Parameters:

refId - A GUID that identifies GradingAssignment.

sectionInfoRefId - The GUID for the SectionInfo object.

termInfoRefId - The GUID for the TermInfo object that defines the marking period that the assignment was created in.

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

gradingCategoryRefId - The GUID for the GradingCategory that this assignment is part of.

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: "A GUID that identifies GradingAssignment."

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: "A GUID that identifies GradingAssignment."

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

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

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 assignment 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 assignment 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

getGradingCategoryRefId

public java.lang.String getGradingCategoryRefId()

Gets the value of the GradingCategoryRefId attribute.

The SIF specification defines the meaning of this attribute as: "The GUID for the GradingCategory that this assignment is part of."

Returns:

The GradingCategoryRefId attribute of this object.

Since:

2.0

setGradingCategoryRefId

public void setGradingCategoryRefId(java.lang.String value)

Sets the value of the GradingCategoryRefId attribute.

The SIF specification defines the meaning of this attribute as: "The GUID for the GradingCategory that this assignment is part of."

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 text-based description of the assignment."

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 text-based description of the assignment."

Parameters:

value - A String object

Since:

2.0

getPointsPossible

public java.lang.Integer getPointsPossible()

Gets the value of the <PointsPossible> element.

The SIF specification defines the meaning of this element as: "The points possible on the assignment."

Returns:

The PointsPossible element of this object.

Since:

2.0

setPointsPossible

public void setPointsPossible(java.lang.Integer value)

Sets the value of the <PointsPossible> element.

The SIF specification defines the meaning of this element as: "The points possible on the assignment."

Parameters:

value - A Integer object

Since:

2.0

getCreateDate

public java.util.Calendar getCreateDate()

Gets the value of the <CreateDate> element.

The SIF specification defines the meaning of this element as: "Creation date of the assignment."

Returns:

The CreateDate element of this object.

Since:

2.0

setCreateDate

public void setCreateDate(java.util.Calendar value)

Sets the value of the <CreateDate> element.

The SIF specification defines the meaning of this element as: "Creation date of the assignment."

Parameters:

value - A Calendar object

Since:

2.0

getDueDate

public java.util.Calendar getDueDate()

Gets the value of the <DueDate> element.

The SIF specification defines the meaning of this element as: "Date the assignment is due."

Returns:

The DueDate element of this object.

Since:

2.0

setDueDate

public void setDueDate(java.util.Calendar value)

Sets the value of the <DueDate> element.

The SIF specification defines the meaning of this element as: "Date the assignment is due."

Parameters:

value - A Calendar object

Since:

2.0

getWeight

public java.math.BigDecimal getWeight()

Gets the value of the <Weight> element.

The SIF specification defines the meaning of this element as: "The weight of the assignment."

Returns:

The Weight element of this object.

Since:

2.0

setWeight

public void setWeight(java.math.BigDecimal value)

Sets the value of the <Weight> element.

The SIF specification defines the meaning of this element as: "The weight of the assignment."

Parameters:

value - A BigDecimal object

Since:

2.0

setDetailedDescription

public void setDetailedDescription(DetailedDescription value)

Sets the value of the <DetailedDescription> element.

The SIF specification defines the meaning of this element as: "This element defines the assignment. If the Type attribute is URL, this is the location of the document that describes the assignment. If Type is PDF, this element will contain the Base64 encoding of the entire document."

Parameters:

value - A DetailedDescription object

Since:

2.0

setDetailedDescription

public void setDetailedDescription(DetailedDescriptionType type,
                                   java.lang.String value)

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

Parameters:

type - The type of information that is contained in the DetailedDescription element.

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

Since:

2.0

getDetailedDescription

public DetailedDescription getDetailedDescription()

Gets the value of the <DetailedDescription> element.

The SIF specification defines the meaning of this element as: "This element defines the assignment. If the Type attribute is URL, this is the location of the document that describes the assignment. If Type is PDF, this element will contain the Base64 encoding of the entire document."

Returns:

A DetailedDescription object

Since:

2.0

removeDetailedDescription

public void removeDetailedDescription()

Removes the DetailedDescription child element previously created by calling setDetailedDescription

Since:

2.0