com.edustructures.sifworks.dw
Class ExclusionRules

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<ExclusionRule>
                  com.edustructures.sifworks.dw.ExclusionRules

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<ExclusionRule>, java.util.Collection<ExclusionRule>

public class ExclusionRules
extends SIFKeyedList<ExclusionRule>

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

ExclusionRules()
Constructor

ExclusionRules(ExclusionRule exclusionRule)
Constructor that accepts values for all mandatory fields

Method Summary

void	addExclusionRule(ExclusionRuleType type, java.lang.String value) Adds a new <ExclusionRule> repeatable element.
ExclusionRule	getExclusionRule(ExclusionRuleType type) Gets an ExclusionRule object instance.
ExclusionRule[]	getExclusionRules() Gets all ExclusionRule object instances.
void	removeExclusionRule(ExclusionRuleType type) Removes an ExclusionRule object instance.
void	setExclusionRules(ExclusionRule[] exclusionrules) Sets an array of ExclusionRule objects.

Methods inherited from class com.edustructures.sifworks.SIFKeyedList

getChild, getChild

Methods inherited from class com.edustructures.sifworks.SIFList

add, addAll, clear, contains, containsAll, get, iterator, remove, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getKey, 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

Methods inherited from interface java.util.Collection

equals, hashCode, isEmpty

Constructor Detail

ExclusionRules

public ExclusionRules()

Constructor

ExclusionRules

public ExclusionRules(ExclusionRule exclusionRule)

Constructor that accepts values for all mandatory fields

Parameters:

exclusionRule - Rule for which statistic may not be reported

Method Detail

addExclusionRule

public void addExclusionRule(ExclusionRuleType type,
                             java.lang.String value)

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

Parameters:

type - Values: Sample, Size, Description

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

Since:

2.0

removeExclusionRule

public void removeExclusionRule(ExclusionRuleType type)

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

Parameters:

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

Since:

2.0

getExclusionRule

public ExclusionRule getExclusionRule(ExclusionRuleType type)

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

Parameters:

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

Returns:

An ExclusionRule object

Since:

2.0

getExclusionRules

public ExclusionRule[] getExclusionRules()

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

Returns:

An array of ExclusionRule objects

Since:

2.0

setExclusionRules

public void setExclusionRules(ExclusionRule[] exclusionrules)

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

Since:

2.0