com.edustructures.sifworks.gradebook
Class Letter

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<ValidMark>
              com.edustructures.sifworks.gradebook.Letter

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<ValidMark>, java.util.Collection<ValidMark>

public class Letter
extends SIFList<ValidMark>

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

Letter()
Constructor

Letter(java.lang.Boolean isAccepted)
Constructor that accepts values for all mandatory fields

Method Summary

void	addValidMark(java.lang.String code) Adds a new <ValidMark> repeatable element.
void	addValidMark(ValidMark value) Adds a new <ValidMark> child element.
java.lang.Boolean	getIsAccepted() Gets the value of the IsAccepted 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
ValidMark	getValidMark(java.lang.String code) Gets a ValidMark object instance.
ValidMark[]	getValidMarks() Gets all ValidMark object instances.
void	removeValidMark(java.lang.String code) Removes a ValidMark object instance.
void	setIsAccepted(java.lang.Boolean value) Sets the value of the IsAccepted attribute.
void	setValidMarks(ValidMark[] validmarks) Sets an array of ValidMark objects.

Methods inherited from class com.edustructures.sifworks.SIFList

add, addAll, clear, contains, containsAll, get, iterator, remove, remove, removeAll, retainAll, size, toArray, toArray

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

Methods inherited from interface java.util.Collection

equals, hashCode, isEmpty

Constructor Detail

Letter

public Letter()

Constructor

Letter

public Letter(java.lang.Boolean isAccepted)

Constructor that accepts values for all mandatory fields

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.

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

getIsAccepted

public java.lang.Boolean getIsAccepted()

Gets the value of the IsAccepted attribute.

The SIF specification defines the meaning of this attribute as: "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."

Returns:

The IsAccepted attribute of this object.

Since:

2.0

setIsAccepted

public void setIsAccepted(java.lang.Boolean value)

Sets the value of the IsAccepted attribute.

The SIF specification defines the meaning of this attribute as: "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."

Parameters:

value - A Boolean object

Since:

2.0

addValidMark

public void addValidMark(ValidMark value)

Adds a new <ValidMark> child element.

Parameters:

value - A ValidMark object

Since:

2.0

addValidMark

public void addValidMark(java.lang.String code)

Adds a new <ValidMark> repeatable element. This form of setValidMark is provided as a convenience method that is functionally equivalent to the version of setValidMark that accepts a single ValidMark object.

Parameters:

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

Since:

2.0

removeValidMark

public void removeValidMark(java.lang.String code)

Removes a ValidMark object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

code - Identifies the ValidMark object to remove by its Code value

Since:

2.0

getValidMark

public ValidMark getValidMark(java.lang.String code)

Gets a ValidMark object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

code - Identifies the ValidMark object to return by its "Code" attribute value

Returns:

A ValidMark object

Since:

2.0

getValidMarks

public ValidMark[] getValidMarks()

Gets all ValidMark object instances. More than one instance can be defined for this object because it is a repeatable field element.

Returns:

An array of ValidMark objects

Since:

2.0

setValidMarks

public void setValidMarks(ValidMark[] validmarks)

Sets an array of ValidMark objects. All existing ValidMark instances are removed and replaced with this list. Calling this method with the parameter value set to null removes all ValidMarks.

Since:

2.0