com.edustructures.sifworks.gradebook
Class ValidMark

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.gradebook.ValidMark

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ValidMark
extends SIFKeyedElement

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

ValidMark()
Constructor

ValidMark(java.lang.String code)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getCode() Gets the value of the <Code> element.
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.math.BigDecimal	getNumericEquivalent() Gets the value of the <NumericEquivalent> element.
void	setCode(java.lang.String value) Sets the value of the <Code> element.
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setNumericEquivalent(java.math.BigDecimal value) Sets the value of the <NumericEquivalent> element.

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getSIFVersion, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, setSIFVersion, 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

ValidMark

public ValidMark()

Constructor

ValidMark

public ValidMark(java.lang.String code)

Constructor that accepts values for all mandatory fields

Parameters:

code - String representing the actual Mark that would appear on the report card (e.g., "A+", "I", "100").

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

getCode

public java.lang.String getCode()

Gets the value of the <Code> element.

The SIF specification defines the meaning of this element as: "String representing the actual Mark that would appear on the report card (e.g., "A+", "I", "100")."

Returns:

The Code element of this object.

Since:

2.0

setCode

public void setCode(java.lang.String value)

Sets the value of the <Code> element.

The SIF specification defines the meaning of this element as: "String representing the actual Mark that would appear on the report card (e.g., "A+", "I", "100")."

Parameters:

value - A String object

Since:

2.0

getNumericEquivalent

public java.math.BigDecimal getNumericEquivalent()

Gets the value of the <NumericEquivalent> element.

The SIF specification defines the meaning of this element as: "Numeric equivalent for the Mark (e.g., 100, 4.0)."

Returns:

The NumericEquivalent element of this object.

Since:

2.0

setNumericEquivalent

public void setNumericEquivalent(java.math.BigDecimal value)

Sets the value of the <NumericEquivalent> element.

The SIF specification defines the meaning of this element as: "Numeric equivalent for the Mark (e.g., 100, 4.0)."

Parameters:

value - A BigDecimal 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 description for this code. (e.g. "Excellent", "Participates in Class", "Incomplete", etc...)."

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 description for this code. (e.g. "Excellent", "Participates in Class", "Incomplete", etc...)."

Parameters:

value - A String object

Since:

2.0