com.edustructures.sifworks.gradebook
Class MarkValueInfo

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

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

MarkValueInfo()
Constructor

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

Method Summary

java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
Letter	getLetter() Gets the value of the <Letter> element.
java.lang.String	getName() Gets the value of the <Name> element.
Narrative	getNarrative() Gets the value of the <Narrative> element.
Numeric	getNumeric() Gets the value of the <Numeric> element.
Percentage	getPercentage() Gets the value of the <Percentage> 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.Integer	getSchoolYear() Gets the value of the <SchoolYear> element.
void	removeLetter() Removes the Letter child element previously created by calling setLetter
void	removeNarrative() Removes the Narrative child element previously created by calling setNarrative
void	removeNumeric() Removes the Numeric child element previously created by calling setNumeric
void	removePercentage() Removes the Percentage child element previously created by calling setPercentage
void	setLetter(java.lang.Boolean isAccepted) Sets the value of the <Letter> child element.
void	setLetter(Letter value) Sets the value of the <Letter> element.
void	setName(java.lang.String value) Sets the value of the <Name> element.
void	setNarrative(Narrative value) Sets the value of the <Narrative> element.
void	setNumeric(Numeric value) Sets the value of the <Numeric> element.
void	setPercentage(Percentage value) Sets the value of the <Percentage> 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	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

MarkValueInfo

public MarkValueInfo()

Constructor

MarkValueInfo

public MarkValueInfo(java.lang.String refId,
                     java.lang.String schoolInfoRefId)

Constructor that accepts values for all mandatory fields

Parameters:

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

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

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

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

Parameters:

value - A Integer object

Since:

2.0

getName

public java.lang.String getName()

Gets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "The text name of the value list ("Letter Grades", "Letter Grades (+/-)", "ESU", "Pass/Fail", "Override Grades", "Citizenship Comment Codes", etc.)."

Returns:

The Name element of this object.

Since:

2.0

setName

public void setName(java.lang.String value)

Sets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "The text name of the value list ("Letter Grades", "Letter Grades (+/-)", "ESU", "Pass/Fail", "Override Grades", "Citizenship Comment Codes", etc.)."

Parameters:

value - A String object

Since:

2.0

setPercentage

public void setPercentage(Percentage value)

Sets the value of the <Percentage> element.

Parameters:

value - A Percentage object

Since:

2.0

getPercentage

public Percentage getPercentage()

Gets the value of the <Percentage> element.

Returns:

A Percentage object

Since:

2.0

removePercentage

public void removePercentage()

Removes the Percentage child element previously created by calling setPercentage

Since:

2.0

setNumeric

public void setNumeric(Numeric value)

Sets the value of the <Numeric> element.

Parameters:

value - A Numeric object

Since:

2.0

getNumeric

public Numeric getNumeric()

Gets the value of the <Numeric> element.

Returns:

A Numeric object

Since:

2.0

removeNumeric

public void removeNumeric()

Removes the Numeric child element previously created by calling setNumeric

Since:

2.0

setLetter

public void setLetter(Letter value)

Sets the value of the <Letter> element.

Parameters:

value - A Letter object

Since:

2.0

setLetter

public void setLetter(java.lang.Boolean isAccepted)

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

Parameters:

isAccepted - Indicates whether a letter Mark is accepted and is used in Change events to unambiguously signal whether support for the Mark has changed, especially ended.

Since:

2.0

getLetter

public Letter getLetter()

Gets the value of the <Letter> element.

Returns:

A Letter object

Since:

2.0

removeLetter

public void removeLetter()

Removes the Letter child element previously created by calling setLetter

Since:

2.0

setNarrative

public void setNarrative(Narrative value)

Sets the value of the <Narrative> element.

Parameters:

value - A Narrative object

Since:

2.0

getNarrative

public Narrative getNarrative()

Gets the value of the <Narrative> element.

Returns:

A Narrative object

Since:

2.0

removeNarrative

public void removeNarrative()

Removes the Narrative child element previously created by calling setNarrative

Since:

2.0