com.edustructures.sifworks.gradebook
Class MarkInfo

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

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

MarkInfo()
Constructor

MarkInfo(java.lang.String refId, java.lang.String markValueInfoRefId, 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	getMarkValueInfoRefId() Gets the value of the MarkValueInfoRefId attribute.
java.lang.String	getRefId() Gets the value of the RefId attribute.
java.lang.String	getSchoolInfoRefId() Gets the value of the SchoolInfoRefId attribute.
java.lang.Integer	getSchoolYear() Gets the value of the <SchoolYear> element.
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setMarkValueInfoRefId(java.lang.String value) Sets the value of the MarkValueInfoRefId attribute.
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	setSchoolYear(java.lang.Integer value) Sets the value of the <SchoolYear> 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

MarkInfo

public MarkInfo()

Constructor

MarkInfo

public MarkInfo(java.lang.String refId,
                java.lang.String markValueInfoRefId,
                java.lang.String schoolInfoRefId)

Constructor that accepts values for all mandatory fields

Parameters:

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

markValueInfoRefId - The ID (GUID) that uniquely identifies the MarkValueInfo.

schoolInfoRefId - The ID (GUID) that uniquely identifies the School that this Mark applies 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: "The ID (GUID) that uniquely identifies this Grading Mark entity."

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: "The ID (GUID) that uniquely identifies this Grading Mark entity."

Parameters:

value - A String object

Since:

2.0

getMarkValueInfoRefId

public java.lang.String getMarkValueInfoRefId()

Gets the value of the MarkValueInfoRefId attribute.

The SIF specification defines the meaning of this attribute as: "The ID (GUID) that uniquely identifies the MarkValueInfo."

Returns:

The MarkValueInfoRefId attribute of this object.

Since:

2.0

setMarkValueInfoRefId

public void setMarkValueInfoRefId(java.lang.String value)

Sets the value of the MarkValueInfoRefId attribute.

The SIF specification defines the meaning of this attribute as: "The ID (GUID) that uniquely identifies the MarkValueInfo."

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 this Mark applies 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 this Mark applies to."

Parameters:

value - A String object

Since:

2.0

getSchoolYear

public java.lang.Integer getSchoolYear()

Gets the value of the <SchoolYear> element.

The SIF specification defines the meaning of this element as: "The year that this MarkInfo applies to."

Returns:

The SchoolYear element of this object.

Since:

2.0

setSchoolYear

public void setSchoolYear(java.lang.Integer value)

Sets the value of the <SchoolYear> element.

The SIF specification defines the meaning of this element as: "The year that this MarkInfo applies to."

Parameters:

value - A Integer 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: "Textual description of the type of Mark (e.g. "Marking Period Grade", "Comment 1", "Comment 2", "Conduct", "Effort", "WorkHabits")."

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: "Textual description of the type of Mark (e.g. "Marking Period Grade", "Comment 1", "Comment 2", "Conduct", "Effort", "WorkHabits")."

Parameters:

value - A String object

Since:

2.0