com.edustructures.sifworks.dw
Class AggregateCharacteristicInfo

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.dw.AggregateCharacteristicInfo

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class AggregateCharacteristicInfo
extends SIFDataObject

This object defines the attribute of a group of objects th at implicitly or explicitly defines a subset of the group. SIF_Events are reported.

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

AggregateCharacteristicInfo()
Constructor

AggregateCharacteristicInfo(java.lang.String refId, java.lang.String definition)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getDefinition() Gets the value of the <Definition> element.
java.lang.String	getDescription() Gets the value of the <Description> element.
java.lang.String	getElementName() Gets the value of the <ElementName> 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
java.lang.String	getRefId() Gets the value of the RefId attribute.
void	setDefinition(java.lang.String value) Sets the value of the <Definition> element.
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setElementName(java.lang.String value) Sets the value of the <ElementName> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.

Methods inherited from class com.edustructures.sifworks.SIFDataObject

addSIFExtendedElement, clone, getElementOrAttribute, getObjectTag, getObjectType, getSIFExtendedElement, getSIFExtendedElements, getSIFExtendedElementsContainer, getSIFMetadata, getSIFVersion, setElementOrAttribute, setElementOrAttribute, setElementOrAttribute, setSIFExtendedElements, setSIFExtendedElementsContainer, setSIFMetadata, setSIFVersion, toXML

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, 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

AggregateCharacteristicInfo

public AggregateCharacteristicInfo()

Constructor

AggregateCharacteristicInfo

public AggregateCharacteristicInfo(java.lang.String refId,
                                   java.lang.String definition)

Constructor that accepts values for all mandatory fields

Parameters:

refId - Key for aggregate characteristic information.

definition - Defines the aggregate characteristic information.

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

getRefId

public java.lang.String getRefId()

Gets the value of the RefId attribute.

The SIF specification defines the meaning of this attribute as: "Key for aggregate characteristic information."

Overrides:

getRefId in class SIFDataObject

Returns:

The RefId attribute of this object.

Since:

1.5r1

setRefId

public void setRefId(java.lang.String value)

Sets the value of the RefId attribute.

The SIF specification defines the meaning of this attribute as: "Key for aggregate characteristic information."

Parameters:

value - A String object

Since:

1.5r1

getDescription

public java.lang.String getDescription()

Gets the value of the <Description> element.

The SIF specification defines the meaning of this element as: "Describes the supercategory of the characteristic described in the Definition element below."

Returns:

The Description element of this object.

Since:

1.5r1

setDescription

public void setDescription(java.lang.String value)

Sets the value of the <Description> element.

The SIF specification defines the meaning of this element as: "Describes the supercategory of the characteristic described in the Definition element below."

Parameters:

value - A String object

Since:

1.5r1

getDefinition

public java.lang.String getDefinition()

Gets the value of the <Definition> element.

The SIF specification defines the meaning of this element as: "Defines the aggregate characteristic information."

Returns:

The Definition element of this object.

Since:

1.5r1

setDefinition

public void setDefinition(java.lang.String value)

Sets the value of the <Definition> element.

The SIF specification defines the meaning of this element as: "Defines the aggregate characteristic information."

Parameters:

value - A String object

Since:

1.5r1

getElementName

public java.lang.String getElementName()

Gets the value of the <ElementName> element.

The SIF specification defines the meaning of this element as: "Reference to SIF elements or external authority (e.g., StudentPersonal/Gender)."

Returns:

The ElementName element of this object.

Since:

1.5r1

setElementName

public void setElementName(java.lang.String value)

Sets the value of the <ElementName> element.

The SIF specification defines the meaning of this element as: "Reference to SIF elements or external authority (e.g., StudentPersonal/Gender)."

Parameters:

value - A String object

Since:

1.5r1