com.edustructures.sifworks.common
Class SIF_ExtendedElement

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.common.SIF_ExtendedElement

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIF_ExtendedElement
extends SIFKeyedElement

A name/value pair, the name being contained in the Name attribute, the value being the element content.

Since:

1.5r1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

SIF_ExtendedElement()
Constructor

SIF_ExtendedElement(java.lang.String name, java.lang.String value)
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
java.lang.String	getName() Gets the value of the Name attribute.
java.lang.String	getSIF_Action() Gets the value of the SIF_Action attribute.
java.lang.String	getValue() Gets the value of the <Value> element.
java.lang.String	getXsiType() Gets the value of the XsiType attribute.
void	setName(java.lang.String value) Sets the value of the Name attribute.
void	setSIF_Action(SIFActionType value) Sets the value of the SIF_Action attribute.
void	setSIF_Action(java.lang.String value) Sets the value of the SIF_Action attribute as a String.
void	setValue(java.lang.String value) Sets the value of the <Value> element.
void	setXsiType(java.lang.String value) Sets the value of the XsiType attribute.

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_ExtendedElement

public SIF_ExtendedElement()

Constructor

SIF_ExtendedElement

public SIF_ExtendedElement(java.lang.String name,
                           java.lang.String value)

Constructor that accepts values for all mandatory fields

Parameters:

name - The name of the extended element. As it is possible that names for extended elements may collide from agent to agent, it is recommended that the names of extended elements be configurable in an agent, or that agents use URIs for the names of extended elements.

value - Gets or sets the content value of the <SIF_ExtendedElement> 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_ExtendedElement> element"

Returns:

The Value element of this object.

Since:

1.5r1

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_ExtendedElement> element"

Parameters:

value - A String object

Since:

1.5r1

getName

public java.lang.String getName()

Gets the value of the Name attribute.

The SIF specification defines the meaning of this attribute as: "The name of the extended element. As it is possible that names for extended elements may collide from agent to agent, it is recommended that the names of extended elements be configurable in an agent, or that agents use URIs for the names of extended elements."

Returns:

The Name attribute of this object.

Since:

1.5r1

setName

public void setName(java.lang.String value)

Sets the value of the Name attribute.

The SIF specification defines the meaning of this attribute as: "The name of the extended element. As it is possible that names for extended elements may collide from agent to agent, it is recommended that the names of extended elements be configurable in an agent, or that agents use URIs for the names of extended elements."

Parameters:

value - A String object

Since:

1.5r1

getXsiType

public java.lang.String getXsiType()

Gets the value of the XsiType attribute.

The SIF specification defines the meaning of this attribute as: "Allows type of element to be explicitly communicated."

Returns:

The XsiType attribute of this object.

Since:

2.0

setXsiType

public void setXsiType(java.lang.String value)

Sets the value of the XsiType attribute.

The SIF specification defines the meaning of this attribute as: "Allows type of element to be explicitly communicated."

Parameters:

value - A String object

Since:

2.0

getSIF_Action

public java.lang.String getSIF_Action()

Gets the value of the SIF_Action attribute.

The SIF specification defines the meaning of this attribute as: "In a Change event, this flag can be used to indicate an element has been deleted from the parent list container. At a minimum the key for the list must also be present."

Returns:

The SIF_Action attribute of this object.

Since:

2.0

setSIF_Action

public void setSIF_Action(SIFActionType value)

Sets the value of the SIF_Action attribute.

The SIF specification defines the meaning of this attribute as: "In a Change event, this flag can be used to indicate an element has been deleted from the parent list container. At a minimum the key for the list must also be present."

Parameters:

value - A constant defined by the SIFActionType class

Since:

2.0

setSIF_Action

public void setSIF_Action(java.lang.String value)

Sets the value of the SIF_Action attribute as a String.

The SIF specification defines the meaning of this attribute as: "In a Change event, this flag can be used to indicate an element has been deleted from the parent list container. At a minimum the key for the list must also be present."

Parameters:

value - The value as a String

Since:

2.0