com.edustructures.sifworks.student
Class AlertMessages

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<AlertMessage>
                  com.edustructures.sifworks.student.AlertMessages

All Implemented Interfaces:

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

public class AlertMessages
extends SIFKeyedList<AlertMessage>

Since:

1.1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

AlertMessages()
Constructor

AlertMessages(AlertMessage alertMessage)
Constructor that accepts values for all mandatory fields

Method Summary

void	addAlertMessage(AlertMessageType type, java.lang.String value) Adds a new <AlertMessage> repeatable element.
AlertMessage	getAlertMessage(AlertMessageType type) Gets an AlertMessage object instance.
AlertMessage[]	getAlertMessages() Gets all AlertMessage object instances.
void	removeAlertMessage(AlertMessageType type) Removes an AlertMessage object instance.
void	setAlertMessages(AlertMessage[] alertmessages) Sets an array of AlertMessage objects.

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

AlertMessages

public AlertMessages()

Constructor

AlertMessages

public AlertMessages(AlertMessage alertMessage)

Constructor that accepts values for all mandatory fields

Parameters:

alertMessage - This is an alert message that is associated with the student.

Method Detail

addAlertMessage

public void addAlertMessage(AlertMessageType type,
                            java.lang.String value)

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

Parameters:

type - This attribute specifies what type of alert message this is.

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

Since:

1.1

removeAlertMessage

public void removeAlertMessage(AlertMessageType type)

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

Parameters:

type - Identifies the AlertMessage object to remove by its Type value

Since:

1.1

getAlertMessage

public AlertMessage getAlertMessage(AlertMessageType type)

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

Parameters:

type - Identifies the AlertMessage object to return by its "Type" attribute value

Returns:

An AlertMessage object

Since:

1.1

getAlertMessages

public AlertMessage[] getAlertMessages()

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

Returns:

An array of AlertMessage objects

Since:

1.1

setAlertMessages

public void setAlertMessages(AlertMessage[] alertmessages)

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

Since:

1.1