com.edustructures.sifworks.infra
Class SIF_EventObject

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.infra.SIF_EventObject

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIF_EventObject
extends SIFElement

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_EventObject()
Constructor

SIF_EventObject(java.lang.String objectName, Action action, java.lang.String value)
Constructor that accepts values for all mandatory fields

Method Summary

void	attach(SIFDataObject payload) Attach a SIFMessagePayload to this EventObject.
void	detach(SIFDataObject payload) Detach a SIFMessagePayload from this EventObject.
java.lang.String	getAction() Gets the value of the Action attribute.
java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
java.lang.String	getObjectName() Gets the value of the ObjectName attribute.
java.lang.String	getValue() Gets the value of the <Value> element.
void	setAction(Action value) Sets the value of the Action attribute.
void	setAction(java.lang.String value) Sets the value of the Action attribute as a String.
void	setObjectName(java.lang.String value) Sets the value of the ObjectName attribute.
void	setValue(java.lang.String value) Sets the value of the <Value> 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_EventObject

public SIF_EventObject()

Constructor

SIF_EventObject

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

Constructor that accepts values for all mandatory fields

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

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

getValue

public java.lang.String getValue()

Gets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "Gets or sets the content value of the <SIF_EventObject> element"

Returns:

The Value element of this object.

Since:

1.1

setValue

public void setValue(java.lang.String value)

Sets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "Gets or sets the content value of the <SIF_EventObject> element"

Parameters:

value - A String object

Since:

1.1

getObjectName

public java.lang.String getObjectName()

Gets the value of the ObjectName attribute.

The SIF specification defines the meaning of this attribute as: "This is the name of the object being added, changed or deleted."

Returns:

The ObjectName attribute of this object.

Since:

1.1

setObjectName

public void setObjectName(java.lang.String value)

Sets the value of the ObjectName attribute.

The SIF specification defines the meaning of this attribute as: "This is the name of the object being added, changed or deleted."

Parameters:

value - A String object

Since:

1.1

getAction

public java.lang.String getAction()

Gets the value of the Action attribute.

The SIF specification defines the meaning of this attribute as: "This is the action associated with the object that is being conveyed by this SIF_Event."

Returns:

The Action attribute of this object.

Since:

1.1

setAction

public void setAction(Action value)

Sets the value of the Action attribute.

The SIF specification defines the meaning of this attribute as: "This is the action associated with the object that is being conveyed by this SIF_Event."

Parameters:

value - A constant defined by the Action class

Since:

1.1

setAction

public void setAction(java.lang.String value)

Sets the value of the Action attribute as a String.

The SIF specification defines the meaning of this attribute as: "This is the action associated with the object that is being conveyed by this SIF_Event."

Parameters:

value - The value as a String

Since:

1.1

attach

public void attach(SIFDataObject payload)

Attach a SIFMessagePayload to this EventObject.

detach

public void detach(SIFDataObject payload)

Detach a SIFMessagePayload from this EventObject.