com.edustructures.sifworks.instr
Class SourceObjects

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<SourceObject>
                  com.edustructures.sifworks.instr.SourceObjects

All Implemented Interfaces:

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

public class SourceObjects
extends SIFKeyedList<SourceObject>

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

SourceObjects()
Constructor

SourceObjects(SourceObject sourceObject)
Constructor that accepts values for all mandatory fields

Method Summary

void	addSourceObject(java.lang.String sifRefObject, java.lang.String value) Adds a new <SourceObject> repeatable element.
SourceObject	getSourceObject(java.lang.String sifRefObject) Gets a SourceObject object instance.
SourceObject[]	getSourceObjects() Gets all SourceObject object instances.
void	removeSourceObject(java.lang.String sifRefObject) Removes a SourceObject object instance.
void	setSourceObjects(SourceObject[] sourceobjects) Sets an array of SourceObject 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

SourceObjects

public SourceObjects()

Constructor

SourceObjects

public SourceObjects(SourceObject sourceObject)

Constructor that accepts values for all mandatory fields

Parameters:

sourceObject -

Method Detail

addSourceObject

public void addSourceObject(java.lang.String sifRefObject,
                            java.lang.String value)

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

Parameters:

sifRefObject - The type of learning object the source object is.

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

Since:

1.5r1

removeSourceObject

public void removeSourceObject(java.lang.String sifRefObject)

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

Parameters:

sifRefObject - Identifies the SourceObject object to remove by its SIF_RefObject value

Since:

1.5r1

getSourceObject

public SourceObject getSourceObject(java.lang.String sifRefObject)

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

Parameters:

sifRefObject - Identifies the SourceObject object to return by its "SIF_RefObject" attribute value

Returns:

A SourceObject object

Since:

1.5r1

getSourceObjects

public SourceObject[] getSourceObjects()

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

Returns:

An array of SourceObject objects

Since:

1.5r1

setSourceObjects

public void setSourceObjects(SourceObject[] sourceobjects)

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

Since:

1.5r1