com.edustructures.sifworks.gradebook
Class MarkInfoList

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<T>
                  com.edustructures.sifworks.SIFActionList<MarkInfoRefId>
                      com.edustructures.sifworks.gradebook.MarkInfoList

All Implemented Interfaces:

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

public class MarkInfoList
extends SIFActionList<MarkInfoRefId>

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

MarkInfoList()
Constructor

MarkInfoList(java.lang.String termInfoRefId, MarkInfoRefId markInfoRefId)
Constructor that accepts values for all mandatory fields

Method Summary

void	addMarkInfoRefId(java.lang.String value) Adds a new <MarkInfoRefId> repeatable 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
MarkInfoRefId	getMarkInfoRefId(java.lang.String value) Gets a MarkInfoRefId object instance.
MarkInfoRefId[]	getMarkInfoRefIds() Gets all MarkInfoRefId object instances.
java.lang.String	getSIF_Action() Gets the value of the SIF_Action attribute.
java.lang.String	getTermInfoRefId() Gets the value of the TermInfoRefId attribute.
void	removeMarkInfoRefId(java.lang.String value) Removes a MarkInfoRefId object instance.
void	setMarkInfoRefIds(MarkInfoRefId[] markinforefids) Sets an array of MarkInfoRefId objects.
void	setSIF_Action(SIFActionType value) Sets the value of the SIF_Action attribute.
void	setSIF_Action(java.lang.String value) Sets the value of the SIF_Action attribute as a String.
void	setTermInfoRefId(java.lang.String value) Sets the value of the TermInfoRefId attribute.

Methods inherited from class com.edustructures.sifworks.SIFKeyedList

getChild, getChild

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

MarkInfoList

public MarkInfoList()

Constructor

MarkInfoList

public MarkInfoList(java.lang.String termInfoRefId,
                    MarkInfoRefId markInfoRefId)

Constructor that accepts values for all mandatory fields

Parameters:

termInfoRefId -

markInfoRefId -

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

getTermInfoRefId

public java.lang.String getTermInfoRefId()

Gets the value of the TermInfoRefId attribute.

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.

Parameters:

value - A String object

Since:

2.0

getSIF_Action

public java.lang.String getSIF_Action()

Gets the value of the SIF_Action attribute.

The SIF specification defines the meaning of this attribute as: "In a Change event, this flag can be used to indicate an element has been deleted from the parent list container. At a minimum the key for the list must also be present."

Returns:

The SIF_Action attribute of this object.

Since:

2.0

setSIF_Action

public void setSIF_Action(SIFActionType value)

Sets the value of the SIF_Action attribute.

The SIF specification defines the meaning of this attribute as: "In a Change event, this flag can be used to indicate an element has been deleted from the parent list container. At a minimum the key for the list must also be present."

Parameters:

value - A constant defined by the SIFActionType class

Since:

2.0

setSIF_Action

public void setSIF_Action(java.lang.String value)

Sets the value of the SIF_Action attribute as a String.

The SIF specification defines the meaning of this attribute as: "In a Change event, this flag can be used to indicate an element has been deleted from the parent list container. At a minimum the key for the list must also be present."

Parameters:

value - The value as a String

Since:

2.0

addMarkInfoRefId

public void addMarkInfoRefId(java.lang.String value)

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

Parameters:

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

Since:

2.0

removeMarkInfoRefId

public void removeMarkInfoRefId(java.lang.String value)

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

Parameters:

value - Identifies the MarkInfoRefId object to remove by its Value value

Since:

2.0

getMarkInfoRefId

public MarkInfoRefId getMarkInfoRefId(java.lang.String value)

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

Parameters:

value - Identifies the MarkInfoRefId object to return by its "Value" attribute value

Returns:

A MarkInfoRefId object

Since:

2.0

getMarkInfoRefIds

public MarkInfoRefId[] getMarkInfoRefIds()

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

Returns:

An array of MarkInfoRefId objects

Since:

2.0

setMarkInfoRefIds

public void setMarkInfoRefIds(MarkInfoRefId[] markinforefids)

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

Since:

2.0