com.edustructures.sifworks.infra
Class SIF_Where

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIF_Where
extends SIFKeyedElement

Since:

2.0

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

SIF_Where()
Constructor

SIF_Where(SIF_ConditionGroup sifConditionGroup)
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.
void	removeSIF_ConditionGroup() Removes the SIF_ConditionGroup child element previously created by calling setSIF_ConditionGroup
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.

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_Where

public SIF_Where()

Constructor

SIF_Where

public SIF_Where(SIF_ConditionGroup sifConditionGroup)

Constructor that accepts values for all mandatory fields

Parameters:

sifConditionGroup -

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_ConditionGroup

public void setSIF_ConditionGroup(SIF_ConditionGroup value)

Sets the value of the <SIF_ConditionGroup> element.

Parameters:

value - A SIF_ConditionGroup object

Since:

2.0

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:

2.0

getSIF_ConditionGroup

public SIF_ConditionGroup getSIF_ConditionGroup()

Gets the value of the <SIF_ConditionGroup> element.

Returns:

A SIF_ConditionGroup object

Since:

2.0

removeSIF_ConditionGroup

public void removeSIF_ConditionGroup()

Removes the SIF_ConditionGroup child element previously created by calling setSIF_ConditionGroup

Since:

2.0