com.edustructures.sifworks.infra
Class SIF_Conditions

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIF_Conditions
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_Conditions()
Constructor

SIF_Conditions(ConditionType type)
Constructor that accepts values for all mandatory fields

Method Summary

void	addSIF_Condition(SIF_Condition value) Adds a new <SIF_Condition> child element.
void	addSIF_Condition(java.lang.String sifElement, Operators sifOperator, java.lang.String sifValue) Adds a new <SIF_Condition> 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
SIF_Condition	getSIF_Condition(java.lang.String sifElement, Operators sifOperator, java.lang.String sifValue) Gets a SIF_Condition object instance.
SIF_Condition[]	getSIF_Conditions() Gets all SIF_Condition object instances.
java.lang.String	getType() Gets the value of the Type attribute.
void	removeSIF_Condition(java.lang.String sifElement, Operators sifOperator, java.lang.String sifValue) Removes a SIF_Condition object instance.
void	setSIF_Conditions(SIF_Condition[] sif_conditions) Sets an array of SIF_Condition objects.
void	setType(ConditionType value) Sets the value of the Type attribute.
void	setType(java.lang.String value) Sets the value of the Type attribute as a String.

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_Conditions

public SIF_Conditions()

Constructor

SIF_Conditions

public SIF_Conditions(ConditionType type)

Constructor that accepts values for all mandatory fields

Parameters:

type -

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

getType

public java.lang.String getType()

Gets the value of the Type attribute.

Returns:

The Type attribute of this object.

Since:

1.1

setType

public void setType(ConditionType value)

Sets the value of the Type attribute.

Parameters:

value - A constant defined by the ConditionType class

Since:

1.1

setType

public void setType(java.lang.String value)

Sets the value of the Type attribute as a String.

Parameters:

value - The value as a String

Since:

1.1

addSIF_Condition

public void addSIF_Condition(SIF_Condition value)

Adds a new <SIF_Condition> child element.

Parameters:

value - A SIF_Condition object

Since:

1.1

addSIF_Condition

public void addSIF_Condition(java.lang.String sifElement,
                             Operators sifOperator,
                             java.lang.String sifValue)

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

Parameters:

sifElement - This is the element/attribute being queried. See below for syntax.

sifOperator - The comparison operator for the condition.

sifValue - SIF_Value is the data that is used to compare with the value of the element or attribute.

Since:

1.1

removeSIF_Condition

public void removeSIF_Condition(java.lang.String sifElement,
                                Operators sifOperator,
                                java.lang.String sifValue)

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

Parameters:

sifElement - Identifies the SIF_Condition object to remove by its SIF_Element value

sifOperator - Identifies the SIF_Condition object to remove by its SIF_Operator value

sifValue - Identifies the SIF_Condition object to remove by its SIF_Value value

Since:

1.1

getSIF_Condition

public SIF_Condition getSIF_Condition(java.lang.String sifElement,
                                      Operators sifOperator,
                                      java.lang.String sifValue)

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

Parameters:

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

sifOperator - Identifies the SIF_Condition object to return by its "SIF_Operator" attribute value

sifValue - Identifies the SIF_Condition object to return by its "SIF_Value" attribute value

Returns:

A SIF_Condition object

Since:

1.1

getSIF_Conditions

public SIF_Condition[] getSIF_Conditions()

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

Returns:

An array of SIF_Condition objects

Since:

1.1

setSIF_Conditions

public void setSIF_Conditions(SIF_Condition[] sif_conditions)

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

Since:

1.1