com.edustructures.sifworks.datamodel
Class Modified

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.datamodel.Modified

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Modified
extends SIFKeyedElement

A single modification event.

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

Modified()
Constructor

Modified(java.lang.String by, java.util.Calendar dateTime)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getBy() Gets the value of the <By> element.
java.util.Calendar	getDateTime() Gets the value of the <DateTime> 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
void	setBy(java.lang.String value) Sets the value of the <By> element.
void	setDateTime(java.util.Calendar value) Sets the value of the <DateTime> element.
void	setDescription(java.lang.String value) Sets the value of the <Description> 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

Modified

public Modified()

Constructor

Modified

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

Constructor that accepts values for all mandatory fields

Parameters:

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

dateTime - The date/time the modification occurred.

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

getBy

public java.lang.String getBy()

Gets the value of the <By> element.

The SIF specification defines the meaning of this element as: "Identifier of the system or person that modified the data."

Returns:

The By element of this object.

Since:

2.0

setBy

public void setBy(java.lang.String value)

Sets the value of the <By> element.

The SIF specification defines the meaning of this element as: "Identifier of the system or person that modified the data."

Parameters:

value - A String object

Since:

2.0

getDateTime

public java.util.Calendar getDateTime()

Gets the value of the <DateTime> element.

The SIF specification defines the meaning of this element as: "The date/time the modification occurred."

Returns:

The DateTime element of this object.

Since:

2.0

setDateTime

public void setDateTime(java.util.Calendar value)

Sets the value of the <DateTime> element.

The SIF specification defines the meaning of this element as: "The date/time the modification occurred."

Parameters:

value - A Calendar 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: "Human readable description of the data modifications."

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: "Human readable description of the data modifications."

Parameters:

value - A String object

Since:

2.0