com.edustructures.sifworks
Class SIFDataObjectXML

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.SIFDataObjectXML

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIFDataObjectXML
extends SIFDataObject

A SIFDataObject implementation that wraps raw XML messages.

Version:

ADK 1.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

SIFDataObjectXML(ElementDef def, java.lang.String xml)
Constructs a SIFDataObject with XML content

SIFDataObjectXML(SIFVersion version, ElementDef def, java.lang.String xml)
Constructs a SIFDataObject with XML content

Method Summary

java.lang.String	getRefId() Gets this object's RefId.
void	setXML(java.lang.String xml) Sets the raw XML message content
java.lang.String	toXML() Gets the raw XML message content

Methods inherited from class com.edustructures.sifworks.SIFDataObject

addSIFExtendedElement, clone, getElementOrAttribute, getObjectTag, getObjectType, getSIFExtendedElement, getSIFExtendedElements, getSIFExtendedElementsContainer, getSIFMetadata, getSIFVersion, setElementOrAttribute, setElementOrAttribute, setElementOrAttribute, setSIFExtendedElements, setSIFExtendedElementsContainer, setSIFMetadata, setSIFVersion

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getKey, getSIFValue, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, 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

SIFDataObjectXML

public SIFDataObjectXML(ElementDef def,
                        java.lang.String xml)

Constructs a SIFDataObject with XML content

Parameters:

def - The ElementDef constant from the SIFDTD class identifying the data object represented by the XML

xml - The XML content

SIFDataObjectXML

public SIFDataObjectXML(SIFVersion version,
                        ElementDef def,
                        java.lang.String xml)

Constructs a SIFDataObject with XML content

Parameters:

version - The version of SIF to associate with this object

def - The ElementDef constant from the SIFDTD class identifying the data object represented by the XML

xml - The XML content

Method Detail

getRefId

public java.lang.String getRefId()

Description copied from class: SIFDataObject

Gets this object's RefId.

Most SIF Data Object elements define a RefId value to uniquely identify the object. However, some objects such as SIF_ZoneStatus and StudentMeal do not have a RefId. For these, a blank string will be returned.

Overrides:

getRefId in class SIFDataObject

Returns:

The value of this object's RefId element

toXML

public java.lang.String toXML()

Gets the raw XML message content

Overrides:

toXML in class SIFDataObject

Returns:

The XML representation of this SIF Data Object

setXML

public void setXML(java.lang.String xml)

Sets the raw XML message content