com.edustructures.sifworks.infra
Class SIF_ConditionGroup

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIF_ConditionGroup
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_ConditionGroup()
Constructor

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

Method Summary

void	addSIF_Conditions(ConditionType type) Adds a new <SIF_Conditions> repeatable element.
void	addSIF_Conditions(SIF_Conditions value) Adds a new <SIF_Conditions> child 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_Conditions	getSIF_Conditions(ConditionType type) Gets a SIF_Conditions object instance.
SIF_Conditions[]	getSIF_Conditionses() Gets all SIF_Conditions object instances.
java.lang.String	getType() Gets the value of the Type attribute.
void	removeSIF_Conditions(ConditionType type) Removes a SIF_Conditions object instance.
void	setSIF_Conditionses(SIF_Conditions[] sif_conditionses) Sets an array of SIF_Conditions 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_ConditionGroup

public SIF_ConditionGroup()

Constructor

SIF_ConditionGroup

public SIF_ConditionGroup(ConditionType type,
                          SIF_Conditions sifConditions)

Constructor that accepts values for all mandatory fields

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 -

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.

The SIF specification defines the meaning of this attribute as: " 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. "

Returns:

The Type attribute of this object.

Since:

1.1

setType

public void setType(ConditionType value)

Sets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: " 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. "

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.

The SIF specification defines the meaning of this attribute as: " 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. "

Parameters:

value - The value as a String

Since:

1.1

addSIF_Conditions

public void addSIF_Conditions(SIF_Conditions value)

Adds a new <SIF_Conditions> child element.

Parameters:

value - A SIF_Conditions object

Since:

1.1

addSIF_Conditions

public void addSIF_Conditions(ConditionType type)

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

Parameters:

type -

Since:

1.1

removeSIF_Conditions

public void removeSIF_Conditions(ConditionType type)

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

Parameters:

type - Identifies the SIF_Conditions object to remove by its Type value

Since:

1.1

getSIF_Conditions

public SIF_Conditions getSIF_Conditions(ConditionType type)

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

Parameters:

type - Identifies the SIF_Conditions object to return by its "Type" attribute value

Returns:

A SIF_Conditions object

Since:

1.1

getSIF_Conditionses

public SIF_Conditions[] getSIF_Conditionses()

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

Returns:

An array of SIF_Conditions objects

Since:

1.1

setSIF_Conditionses

public void setSIF_Conditionses(SIF_Conditions[] sif_conditionses)

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

Since:

1.1