com.edustructures.sifworks.infra
Class SIF_Query

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIF_Query
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_Query()
Constructor

SIF_Query(SIF_QueryObject sifQueryObject)
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_ConditionGroup	getSIF_ConditionGroup() Gets the value of the <SIF_ConditionGroup> element.
SIF_Example	getSIF_Example() Gets the value of the <SIF_Example> element.
SIF_QueryObject	getSIF_QueryObject() Gets the value of the <SIF_QueryObject> element.
void	removeSIF_ConditionGroup() Removes the SIF_ConditionGroup child element previously created by calling setSIF_ConditionGroup
void	removeSIF_Example() Removes the SIF_Example child element previously created by calling setSIF_Example
void	removeSIF_QueryObject() Removes the SIF_QueryObject child element previously created by calling setSIF_QueryObject
void	setSIF_ConditionGroup(ConditionType type, SIF_Conditions sifConditions) Sets the value of the <SIF_ConditionGroup> child element.
void	setSIF_ConditionGroup(SIF_ConditionGroup value) Sets the value of the <SIF_ConditionGroup> element.
void	setSIF_Example(SIF_Example value) Sets the value of the <SIF_Example> element.
void	setSIF_Example(java.lang.String value) Sets the value of the <SIF_Example> child element.
void	setSIF_QueryObject(SIF_QueryObject value) Sets the value of the <SIF_QueryObject> element.
void	setSIF_QueryObject(java.lang.String objectName) Sets the value of the <SIF_QueryObject> 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_Query

public SIF_Query()

Constructor

SIF_Query

public SIF_Query(SIF_QueryObject sifQueryObject)

Constructor that accepts values for all mandatory fields

Parameters:

sifQueryObject -

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_QueryObject

public void setSIF_QueryObject(SIF_QueryObject value)

Sets the value of the <SIF_QueryObject> element.

Parameters:

value - A SIF_QueryObject object

Since:

1.1

setSIF_QueryObject

public void setSIF_QueryObject(java.lang.String objectName)

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

Parameters:

objectName -

Since:

1.1

getSIF_QueryObject

public SIF_QueryObject getSIF_QueryObject()

Gets the value of the <SIF_QueryObject> element.

Returns:

A SIF_QueryObject object

Since:

1.1

removeSIF_QueryObject

public void removeSIF_QueryObject()

Removes the SIF_QueryObject child element previously created by calling setSIF_QueryObject

Since:

1.1

setSIF_ConditionGroup

public void setSIF_ConditionGroup(SIF_ConditionGroup value)

Sets the value of the <SIF_ConditionGroup> element.

The SIF specification defines the meaning of this element as: " Either SIF_ConditionGroup or SIF_Example may optionally be specified to present conditions matching objects should satisfy. "

Parameters:

value - A SIF_ConditionGroup object

Since:

1.1

setSIF_ConditionGroup

public void setSIF_ConditionGroup(ConditionType type,
                                  SIF_Conditions sifConditions)

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

Parameters:

type - The Boolean operator for joining conditions (SIF_Conditions elements) within this element. Note that None should be used if there is only one SIF_Conditions element.

sifConditions -

Since:

1.1

getSIF_ConditionGroup

public SIF_ConditionGroup getSIF_ConditionGroup()

Gets the value of the <SIF_ConditionGroup> element.

The SIF specification defines the meaning of this element as: " Either SIF_ConditionGroup or SIF_Example may optionally be specified to present conditions matching objects should satisfy. "

Returns:

A SIF_ConditionGroup object

Since:

1.1

removeSIF_ConditionGroup

public void removeSIF_ConditionGroup()

Removes the SIF_ConditionGroup child element previously created by calling setSIF_ConditionGroup

Since:

1.1

setSIF_Example

public void setSIF_Example(SIF_Example value)

Sets the value of the <SIF_Example> element.

The SIF specification defines the meaning of this element as: " An example SIF object that serves as a template for matching objects. There is an implied EQ operator for every element/attribute value present and an implied And group of all resulting conditions. Currently this is an experimental feature and limited to use with LearnerLocator; wider use may be considered in future major versions of this specification. "

Parameters:

value - A SIF_Example object

Since:

2.0

setSIF_Example

public void setSIF_Example(java.lang.String value)

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

Parameters:

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

Since:

2.0

getSIF_Example

public SIF_Example getSIF_Example()

Gets the value of the <SIF_Example> element.

The SIF specification defines the meaning of this element as: " An example SIF object that serves as a template for matching objects. There is an implied EQ operator for every element/attribute value present and an implied And group of all resulting conditions. Currently this is an experimental feature and limited to use with LearnerLocator; wider use may be considered in future major versions of this specification. "

Returns:

A SIF_Example object

Since:

2.0

removeSIF_Example

public void removeSIF_Example()

Removes the SIF_Example child element previously created by calling setSIF_Example

Since:

2.0