com.edustructures.sifworks.dw
Class Characteristics

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<AggregateCharacteristicInfoRefId>
                  com.edustructures.sifworks.dw.Characteristics

All Implemented Interfaces:

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

public class Characteristics
extends SIFKeyedList<AggregateCharacteristicInfoRefId>

Since:

1.5r1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

Characteristics()
Constructor

Characteristics(AggregateCharacteristicInfoRefId aggregateCharacteristicInfoRefId)
Constructor that accepts values for all mandatory fields

Method Summary

void	addAggregateCharacteristicInfoRefId(java.lang.String value) Adds a new <AggregateCharacteristicInfoRefId> repeatable element.
AggregateCharacteristicInfoRefId	getAggregateCharacteristicInfoRefId(java.lang.String value) Gets an AggregateCharacteristicInfoRefId object instance.
AggregateCharacteristicInfoRefId[]	getAggregateCharacteristicInfoRefIds() Gets all AggregateCharacteristicInfoRefId object instances.
java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
void	removeAggregateCharacteristicInfoRefId(java.lang.String value) Removes an AggregateCharacteristicInfoRefId object instance.
void	setAggregateCharacteristicInfoRefIds(AggregateCharacteristicInfoRefId[] aggregatecharacteristicinforefids) Sets an array of AggregateCharacteristicInfoRefId 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, 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

Characteristics

public Characteristics()

Constructor

Characteristics

public Characteristics(AggregateCharacteristicInfoRefId aggregateCharacteristicInfoRefId)

Constructor that accepts values for all mandatory fields

Parameters:

aggregateCharacteristicInfoRefId - Reference to an AggregateCharacteristicInfo object.

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

addAggregateCharacteristicInfoRefId

public void addAggregateCharacteristicInfoRefId(java.lang.String value)

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

Parameters:

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

Since:

1.5r1

removeAggregateCharacteristicInfoRefId

public void removeAggregateCharacteristicInfoRefId(java.lang.String value)

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

Parameters:

value - Identifies the AggregateCharacteristicInfoRefId object to remove by its Value value

Since:

1.5r1

getAggregateCharacteristicInfoRefId

public AggregateCharacteristicInfoRefId getAggregateCharacteristicInfoRefId(java.lang.String value)

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

Parameters:

value - Identifies the AggregateCharacteristicInfoRefId object to return by its "Value" attribute value

Returns:

An AggregateCharacteristicInfoRefId object

Since:

1.5r1

getAggregateCharacteristicInfoRefIds

public AggregateCharacteristicInfoRefId[] getAggregateCharacteristicInfoRefIds()

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

Returns:

An array of AggregateCharacteristicInfoRefId objects

Since:

1.5r1

setAggregateCharacteristicInfoRefIds

public void setAggregateCharacteristicInfoRefIds(AggregateCharacteristicInfoRefId[] aggregatecharacteristicinforefids)

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

Since:

1.5r1