com.edustructures.sifworks.instr
Class CurriculumHierarchyLevel

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.instr.CurriculumHierarchyLevel

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CurriculumHierarchyLevel
extends SIFKeyedElement

Integer assigned to each hierarchical level within the CurriculumStructure tree. The top level is "1".

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

CurriculumHierarchyLevel()
Constructor

CurriculumHierarchyLevel(java.lang.String name, java.lang.Integer number, java.lang.String description)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getDescription() Gets the value of the Description attribute.
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	getName() Gets the value of the Name attribute.
java.lang.Integer	getNumber() Gets the value of the <Number> element.
void	setDescription(java.lang.String value) Sets the value of the Description attribute.
void	setName(java.lang.String value) Sets the value of the Name attribute.
void	setNumber(java.lang.Integer value) Sets the value of the <Number> element.

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

CurriculumHierarchyLevel

public CurriculumHierarchyLevel()

Constructor

CurriculumHierarchyLevel

public CurriculumHierarchyLevel(java.lang.String name,
                                java.lang.Integer number,
                                java.lang.String description)

Constructor that accepts values for all mandatory fields

Parameters:

name - Used to describe what role this is serving in the structure. Some curriculum objects describe their levels in terms of programs of study, courses and units. Others use other terms. This attribute names the level of the item.

number - Integer assigned to each hierarchical level within the CurriculumStructure tree. The top level is 1.

description - Used to describe what role this is serving in the structure. Some curriculum objects describe their levels in terms of programs of study, courses and units. Others use other terms.

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

getName

public java.lang.String getName()

Gets the value of the Name attribute.

The SIF specification defines the meaning of this attribute as: "Used to describe what role this is serving in the structure. Some curriculum objects describe their levels in terms of programs of study, courses and units. Others use other terms. This attribute names the level of the item."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.5r1	"HierarchyLevelName"
SIF2.0	"Name"

Returns:

The Name attribute of this object.

Since:

1.5r1

setName

public void setName(java.lang.String value)

Sets the value of the Name attribute.

The SIF specification defines the meaning of this attribute as: "Used to describe what role this is serving in the structure. Some curriculum objects describe their levels in terms of programs of study, courses and units. Others use other terms. This attribute names the level of the item."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.5r1	"HierarchyLevelName"
SIF2.0	"Name"

Parameters:

value - A String object

Since:

1.5r1

getNumber

public java.lang.Integer getNumber()

Gets the value of the <Number> element.

The SIF specification defines the meaning of this element as: "Integer assigned to each hierarchical level within the CurriculumStructure tree. The top level is 1."

Returns:

The Number element of this object.

Since:

2.0

setNumber

public void setNumber(java.lang.Integer value)

Sets the value of the <Number> element.

The SIF specification defines the meaning of this element as: "Integer assigned to each hierarchical level within the CurriculumStructure tree. The top level is 1."

Parameters:

value - A Integer object

Since:

2.0

getDescription

public java.lang.String getDescription()

Gets the value of the Description attribute.

The SIF specification defines the meaning of this attribute as: "Used to describe what role this is serving in the structure. Some curriculum objects describe their levels in terms of programs of study, courses and units. Others use other terms."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.5r1	"HierarchyLevelDescription"
SIF2.0	"Description"

Returns:

The Description attribute of this object.

Since:

1.5r1

setDescription

public void setDescription(java.lang.String value)

Sets the value of the Description attribute.

The SIF specification defines the meaning of this attribute as: "Used to describe what role this is serving in the structure. Some curriculum objects describe their levels in terms of programs of study, courses and units. Others use other terms."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.5r1	"HierarchyLevelDescription"
SIF2.0	"Description"

Parameters:

value - A String object

Since:

1.5r1