com.edustructures.sifworks.instr
Class PredecessorObjects

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<CurriculumStructureRefId>
                  com.edustructures.sifworks.instr.PredecessorObjects

All Implemented Interfaces:

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

public class PredecessorObjects
extends SIFKeyedList<CurriculumStructureRefId>

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

PredecessorObjects()
Constructor

PredecessorObjects(CurriculumStructureRefId curriculumStructureRefId)
Constructor that accepts values for all mandatory fields

Method Summary

void	addCurriculumStructureRefId(java.lang.String value) Adds a new <CurriculumStructureRefId> repeatable element.
CurriculumStructureRefId	getCurriculumStructureRefId(java.lang.String value) Gets a CurriculumStructureRefId object instance.
CurriculumStructureRefId[]	getCurriculumStructureRefIds() Gets all CurriculumStructureRefId object instances.
void	removeCurriculumStructureRefId(java.lang.String value) Removes a CurriculumStructureRefId object instance.
void	setCurriculumStructureRefIds(CurriculumStructureRefId[] curriculumstructurerefids) Sets an array of CurriculumStructureRefId 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

PredecessorObjects

public PredecessorObjects()

Constructor

PredecessorObjects

public PredecessorObjects(CurriculumStructureRefId curriculumStructureRefId)

Constructor that accepts values for all mandatory fields

Parameters:

curriculumStructureRefId - GUID assigned to the CurriculumStructure object directly above it in the hierarchy tree.

Method Detail

addCurriculumStructureRefId

public void addCurriculumStructureRefId(java.lang.String value)

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

Parameters:

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

Since:

1.5r1

removeCurriculumStructureRefId

public void removeCurriculumStructureRefId(java.lang.String value)

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

Parameters:

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

Since:

1.5r1

getCurriculumStructureRefId

public CurriculumStructureRefId getCurriculumStructureRefId(java.lang.String value)

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

Parameters:

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

Returns:

A CurriculumStructureRefId object

Since:

1.5r1

getCurriculumStructureRefIds

public CurriculumStructureRefId[] getCurriculumStructureRefIds()

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

Returns:

An array of CurriculumStructureRefId objects

Since:

1.5r1

setCurriculumStructureRefIds

public void setCurriculumStructureRefIds(CurriculumStructureRefId[] curriculumstructurerefids)

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

Since:

1.5r1