com.edustructures.sifworks.instr
Class Organizations

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<Organization>
                  com.edustructures.sifworks.instr.Organizations

All Implemented Interfaces:

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

public class Organizations
extends SIFKeyedList<Organization>

Since:

2.0

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

Organizations()
Constructor

Organizations(Organization organization)
Constructor that accepts values for all mandatory fields

Method Summary

void	addOrganization(java.lang.String value) Adds a new <Organization> repeatable element.
java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
Organization	getOrganization(java.lang.String value) Gets an Organization object instance.
Organization[]	getOrganizations() Gets all Organization object instances.
void	removeOrganization(java.lang.String value) Removes an Organization object instance.
void	setOrganizations(Organization[] organizations) Sets an array of Organization 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, 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

Organizations

public Organizations()

Constructor

Organizations

public Organizations(Organization organization)

Constructor that accepts values for all mandatory fields

Parameters:

organization - Name of organization represented by the document, i.e., "National Council of Teachers of Mathematics (NCTM)," "Washington," "Seattle School District."

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

addOrganization

public void addOrganization(java.lang.String value)

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

Parameters:

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

Since:

2.0

removeOrganization

public void removeOrganization(java.lang.String value)

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

Parameters:

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

Since:

2.0

getOrganization

public Organization getOrganization(java.lang.String value)

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

Parameters:

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

Returns:

An Organization object

Since:

2.0

getOrganizations

public Organization[] getOrganizations()

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

Returns:

An array of Organization objects

Since:

2.0

setOrganizations

public void setOrganizations(Organization[] organizations)

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

Since:

2.0