com.edustructures.sifworks.instr
Class AssociatedObjects

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<AssociatedObject>
                  com.edustructures.sifworks.instr.AssociatedObjects

All Implemented Interfaces:

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

public class AssociatedObjects
extends SIFKeyedList<AssociatedObject>

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

AssociatedObjects()
Constructor

AssociatedObjects(AssociatedObject associatedObject)
Constructor that accepts values for all mandatory fields

Method Summary

void	addAssociatedObject(java.lang.String sifRefObject, java.lang.String value) Adds a new <AssociatedObject> repeatable element.
AssociatedObject	getAssociatedObject(java.lang.String sifRefObject) Gets an AssociatedObject object instance.
AssociatedObject[]	getAssociatedObjects() Gets all AssociatedObject object instances.
void	removeAssociatedObject(java.lang.String sifRefObject) Removes an AssociatedObject object instance.
void	setAssociatedObjects(AssociatedObject[] associatedobjects) Sets an array of AssociatedObject 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

AssociatedObjects

public AssociatedObjects()

Constructor

AssociatedObjects

public AssociatedObjects(AssociatedObject associatedObject)

Constructor that accepts values for all mandatory fields

Parameters:

associatedObject -

Method Detail

addAssociatedObject

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

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

Parameters:

sifRefObject - Attribute that identifies the type of SIF object being referenced.

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

Since:

1.5r1

removeAssociatedObject

public void removeAssociatedObject(java.lang.String sifRefObject)

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

Parameters:

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

Since:

1.5r1

getAssociatedObject

public AssociatedObject getAssociatedObject(java.lang.String sifRefObject)

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

Parameters:

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

Returns:

An AssociatedObject object

Since:

1.5r1

getAssociatedObjects

public AssociatedObject[] getAssociatedObjects()

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

Returns:

An array of AssociatedObject objects

Since:

1.5r1

setAssociatedObjects

public void setAssociatedObjects(AssociatedObject[] associatedobjects)

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

Since:

1.5r1