com.edustructures.sifworks.common
Class SchoolContactList

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<SchoolContact>
                  com.edustructures.sifworks.common.SchoolContactList

All Implemented Interfaces:

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

public class SchoolContactList
extends SIFKeyedList<SchoolContact>

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

SchoolContactList()
Constructor

SchoolContactList(SchoolContact schoolContact)
Constructor that accepts values for all mandatory fields

Method Summary

void	addSchoolContact(ContactInfo contactInfo) Adds a new <SchoolContact> repeatable element.
SchoolContact	getSchoolContact(ContactInfo contactInfo) Gets a SchoolContact object instance.
SchoolContact[]	getSchoolContacts() Gets all SchoolContact object instances.
void	removeSchoolContact(ContactInfo contactInfo) Removes a SchoolContact object instance.
void	setSchoolContacts(SchoolContact[] schoolcontacts) Sets an array of SchoolContact 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

SchoolContactList

public SchoolContactList()

Constructor

SchoolContactList

public SchoolContactList(SchoolContact schoolContact)

Constructor that accepts values for all mandatory fields

Parameters:

schoolContact - Information on contact persons for this school.

Method Detail

addSchoolContact

public void addSchoolContact(ContactInfo contactInfo)

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

Parameters:

contactInfo - For a description of this element, see 5.1.3 ContactInfo.

Since:

1.5r1

removeSchoolContact

public void removeSchoolContact(ContactInfo contactInfo)

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

Parameters:

contactInfo - Identifies the SchoolContact object to remove by its ContactInfo value

Since:

1.5r1

getSchoolContact

public SchoolContact getSchoolContact(ContactInfo contactInfo)

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

Parameters:

contactInfo - Identifies the SchoolContact object to return by its "ContactInfo" attribute value

Returns:

A SchoolContact object

Since:

1.5r1

getSchoolContacts

public SchoolContact[] getSchoolContacts()

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

Returns:

An array of SchoolContact objects

Since:

1.5r1

setSchoolContacts

public void setSchoolContacts(SchoolContact[] schoolcontacts)

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

Since:

1.5r1