com.edustructures.sifworks.instr
Class Prerequisites

java.lang.Object
  extended by com.edustructures.sifworks.Element
      extended by com.edustructures.sifworks.SIFElement
          extended by com.edustructures.sifworks.SIFList<T>
              extended by com.edustructures.sifworks.SIFKeyedList<Prerequisite>
                  extended by com.edustructures.sifworks.instr.Prerequisites
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<Prerequisite>, java.util.Collection<Prerequisite>

public class Prerequisites
extends SIFKeyedList<Prerequisite>

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
Prerequisites()
          Constructor
Prerequisites(Prerequisite prerequisite)
          Constructor that accepts values for all mandatory fields
 
Method Summary
 void addPrerequisite(java.lang.String value)
          Adds a new <Prerequisite> repeatable element.
 Prerequisite getPrerequisite(java.lang.String value)
          Gets a Prerequisite object instance.
 Prerequisite[] getPrerequisites()
          Gets all Prerequisite object instances.
 void removePrerequisite(java.lang.String value)
          Removes a Prerequisite object instance.
 void setPrerequisites(Prerequisite[] prerequisites)
          Sets an array of Prerequisite 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

Prerequisites

public Prerequisites()
Constructor


Prerequisites

public Prerequisites(Prerequisite prerequisite)
Constructor that accepts values for all mandatory fields

Parameters:
prerequisite - Skill or competency the student must have to engage in activity.
Method Detail

addPrerequisite

public void addPrerequisite(java.lang.String value)
Adds a new <Prerequisite> repeatable element. This form of setPrerequisite is provided as a convenience method that is functionally equivalent to the version of setPrerequisite that accepts a single Prerequisite object.

Parameters:
value - Gets or sets the content value of the <Prerequisite> element
Since:
1.5r1

removePrerequisite

public void removePrerequisite(java.lang.String value)
Removes a Prerequisite object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:
value - Identifies the Prerequisite object to remove by its Value value
Since:
1.5r1

getPrerequisite

public Prerequisite getPrerequisite(java.lang.String value)
Gets a Prerequisite object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:
value - Identifies the Prerequisite object to return by its "Value" attribute value
Returns:
A Prerequisite object
Since:
1.5r1

getPrerequisites

public Prerequisite[] getPrerequisites()
Gets all Prerequisite object instances. More than one instance can be defined for this object because it is a repeatable field element.

Returns:
An array of Prerequisite objects
Since:
1.5r1

setPrerequisites

public void setPrerequisites(Prerequisite[] prerequisites)
Sets an array of Prerequisite objects. All existing Prerequisite instances are removed and replaced with this list. Calling this method with the parameter value set to null removes all Prerequisites.

Since:
1.5r1


Copyright © 2001-2007 Edustructures LLC. All Rights Reserved. SIFWorks® and ADK® are registered trademarks of Edustructures LLC. SIF™ and Schools Interoperability Framework are trademarks of the Schools Interoperability Framework Association.