com.edustructures.sifworks.infra
Class SIF_ObjectData

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.infra.SIF_ObjectData

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIF_ObjectData
extends SIFKeyedElement

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

SIF_ObjectData()
Constructor

SIF_ObjectData(SIF_EventObject sifEventObject)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
SIF_EventObject	getSIF_EventObject() Gets the value of the <SIF_EventObject> element.
void	removeSIF_EventObject() Removes the SIF_EventObject child element previously created by calling setSIF_EventObject
void	setSIF_EventObject(SIF_EventObject value) Sets the value of the <SIF_EventObject> element.
void	setSIF_EventObject(java.lang.String objectName, Action action, java.lang.String value) Sets the value of the <SIF_EventObject> child 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

SIF_ObjectData

public SIF_ObjectData()

Constructor

SIF_ObjectData

public SIF_ObjectData(SIF_EventObject sifEventObject)

Constructor that accepts values for all mandatory fields

Parameters:

sifEventObject - Contains the actual object (partial or whole) that is being added, changed or deleted.

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

setSIF_EventObject

public void setSIF_EventObject(SIF_EventObject value)

Sets the value of the <SIF_EventObject> element.

The SIF specification defines the meaning of this element as: "Contains the actual object (partial or whole) that is being added, changed or deleted."

Parameters:

value - A SIF_EventObject object

Since:

1.1

setSIF_EventObject

public void setSIF_EventObject(java.lang.String objectName,
                               Action action,
                               java.lang.String value)

Sets the value of the <SIF_EventObject> child element. This form of setSIF_EventObject is provided as a convenience method that is functionally equivalent to the version of setSIF_EventObject that accepts a single SIF_EventObject object.

Parameters:

objectName - This is the name of the object being added, changed or deleted.

action - This is the action associated with the object that is being conveyed by this SIF_Event.

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

Since:

1.1

getSIF_EventObject

public SIF_EventObject getSIF_EventObject()

Gets the value of the <SIF_EventObject> element.

The SIF specification defines the meaning of this element as: "Contains the actual object (partial or whole) that is being added, changed or deleted."

Returns:

A SIF_EventObject object

Since:

1.1

removeSIF_EventObject

public void removeSIF_EventObject()

Removes the SIF_EventObject child element previously created by calling setSIF_EventObject

Since:

1.1