com.edustructures.sifworks.datamodel
Class ModificationHistory

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<Modified>
                  com.edustructures.sifworks.datamodel.ModificationHistory

All Implemented Interfaces:

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

public class ModificationHistory
extends SIFKeyedList<Modified>

An ordered set of Modified elements describing which system modified the data, when the modification took place, and a brief description of the modification.

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

ModificationHistory()
Constructor

ModificationHistory(Modified modified)
Constructor that accepts values for all mandatory fields

Method Summary

void	addModified(java.lang.String by, java.util.Calendar dateTime) Adds a new <Modified> repeatable element.
Modified	getModified(java.util.Calendar dateTime) Gets a Modified object instance.
Modified[]	getModifieds() Gets all Modified object instances.
void	removeModified(java.util.Calendar dateTime) Removes a Modified object instance.
void	setModifieds(Modified[] modifieds) Sets an array of Modified 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

ModificationHistory

public ModificationHistory()

Constructor

ModificationHistory

public ModificationHistory(Modified modified)

Constructor that accepts values for all mandatory fields

Parameters:

modified -

Method Detail

addModified

public void addModified(java.lang.String by,
                        java.util.Calendar dateTime)

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

Parameters:

by - Identifier of the system or person that modified the data.

dateTime - The date/time the modification occurred.

Since:

2.0

removeModified

public void removeModified(java.util.Calendar dateTime)

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

Parameters:

dateTime - Identifies the Modified object to remove by its DateTime value

Since:

2.0

getModified

public Modified getModified(java.util.Calendar dateTime)

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

Parameters:

dateTime - Identifies the Modified object to return by its "DateTime" attribute value

Returns:

A Modified object

Since:

2.0

getModifieds

public Modified[] getModifieds()

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

Returns:

An array of Modified objects

Since:

2.0

setModifieds

public void setModifieds(Modified[] modifieds)

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

Since:

2.0