com.edustructures.sifworks.infra
Class SIF_QueryObject

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIF_QueryObject
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_QueryObject()
Constructor

SIF_QueryObject(java.lang.String objectName)
Constructor that accepts values for all mandatory fields

Method Summary

void	addSIF_Element(SIF_Element value) Adds a new <SIF_Element> child element.
void	addSIF_Element(java.lang.String value) Adds a new <SIF_Element> repeatable 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
java.lang.String	getObjectName() Gets the value of the ObjectName attribute.
SIF_Element	getSIF_Element(java.lang.String value) Gets a SIF_Element object instance.
SIF_Element[]	getSIF_Elements() Gets all SIF_Element object instances.
void	removeSIF_Element(java.lang.String value) Removes a SIF_Element object instance.
void	setObjectName(java.lang.String value) Sets the value of the ObjectName attribute.
void	setSIF_Elements(SIF_Element[] sif_elements) Sets an array of SIF_Element objects.

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_QueryObject

public SIF_QueryObject()

Constructor

SIF_QueryObject

public SIF_QueryObject(java.lang.String objectName)

Constructor that accepts values for all mandatory fields

Parameters:

objectName -

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

getObjectName

public java.lang.String getObjectName()

Gets the value of the ObjectName attribute.

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.

Parameters:

value - A String object

Since:

1.1

addSIF_Element

public void addSIF_Element(SIF_Element value)

Adds a new <SIF_Element> child element.

The SIF specification defines the meaning of this element as: "Individual elements/attributes being requested of matching object. See syntax below. If specified, only the elements/attributes requested are returned in the SIF_Response (with any parent elements/attributes); otherwise, all elements supported by the provider's object are returned."

Parameters:

value - A SIF_Element object

Since:

1.1

addSIF_Element

public void addSIF_Element(java.lang.String value)

Adds a new <SIF_Element> repeatable element. This form of setSIF_Element is provided as a convenience method that is functionally equivalent to the version of setSIF_Element that accepts a single SIF_Element object.

Parameters:

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

Since:

1.1

removeSIF_Element

public void removeSIF_Element(java.lang.String value)

Removes a SIF_Element object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

value - Identifies the SIF_Element object to remove by its Value value

Since:

1.1

getSIF_Element

public SIF_Element getSIF_Element(java.lang.String value)

Gets a SIF_Element object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

value - Identifies the SIF_Element object to return by its "Value" attribute value

Returns:

A SIF_Element object

Since:

1.1

getSIF_Elements

public SIF_Element[] getSIF_Elements()

Gets all SIF_Element object instances. More than one instance can be defined for this object because it is a repeatable field element.

Returns:

An array of SIF_Element objects

Since:

1.1

setSIF_Elements

public void setSIF_Elements(SIF_Element[] sif_elements)

Sets an array of SIF_Element objects. All existing SIF_Element instances are removed and replaced with this list. Calling this method with the parameter value set to null removes all SIF_Elements.

Since:

1.1