microsoft.exchange.webservices.data
Class AttendeeCollection

java.lang.Object
  extended by microsoft.exchange.webservices.data.ComplexProperty
      extended by microsoft.exchange.webservices.data.ComplexPropertyCollection<Attendee>
          extended by microsoft.exchange.webservices.data.AttendeeCollection
All Implemented Interfaces:
java.lang.Iterable<Attendee>

public final class AttendeeCollection
extends ComplexPropertyCollection<Attendee>

Represents a collection of attendees.


Constructor Summary
protected AttendeeCollection()
          Initializes a new instance of the AttendeeCollection class.
 
Method Summary
 void add(Attendee attendee)
          * Adds an attendee to the collection.
 Attendee add(java.lang.String smtpAddress)
          * Adds an attendee to the collection.
 Attendee add(java.lang.String name, java.lang.String smtpAddress)
          * Adds an attendee to the collection.
 void clear()
          Clears the collection.
protected  Attendee createComplexProperty(java.lang.String xmlElementName)
          * Creates an Attendee object from an XML element name.
protected  java.lang.String getCollectionItemXmlElementName(Attendee attendee)
          * Retrieves the XML element name corresponding to the provided Attendee object.
 boolean remove(Attendee attendee)
          * Removes an attendee from the collection.
 void removeAt(int index)
          * Removes an attendee from the collection.
 
Methods inherited from class microsoft.exchange.webservices.data.ComplexPropertyCollection
clearChangeLog, complexPropertyChanged, contains, getAddedItems, getCount, getItems, getModifiedItems, getPropertyAtIndex, getRemovedItems, indexOf, internalAdd, internalClear, internalRemove, internalRemoveAt, itemChanged, iterator, loadFromXml, loadFromXml, removeFromChangeLog, shouldWriteToXml, updateFromXml, writeDeleteUpdateToXml, writeElementsToXml, writeSetUpdateToXml, writeToXml
 
Methods inherited from class microsoft.exchange.webservices.data.ComplexProperty
addOnChangeEvent, canSetFieldValue, changed, clearChangeEvents, func, getNamespace, internalValidate, readAttributesFromXml, readTextValueFromXml, removeChangeEvent, setNamespace, tryReadElementFromXml, tryReadElementFromXmlToPatch, updateFromXml, validate, writeAttributesToXml, writeToXml
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AttendeeCollection

protected AttendeeCollection()
Initializes a new instance of the AttendeeCollection class.

Method Detail

add

public void add(Attendee attendee)
* Adds an attendee to the collection.

Parameters:
attendee - the attendee

add

public Attendee add(java.lang.String smtpAddress)
             throws java.lang.Exception
* Adds an attendee to the collection.

Parameters:
smtpAddress - the smtp address
Returns:
An Attendee instance initialized with the provided SMTP address.
Throws:
java.lang.Exception - the exception

add

public Attendee add(java.lang.String name,
                    java.lang.String smtpAddress)
* Adds an attendee to the collection.

Parameters:
name - the name
smtpAddress - the smtp address
Returns:
An Attendee instance initialized with the provided name and SMTP address.

clear

public void clear()
Clears the collection.


removeAt

public void removeAt(int index)
* Removes an attendee from the collection.

Parameters:
index - the index

remove

public boolean remove(Attendee attendee)
               throws java.lang.Exception
* Removes an attendee from the collection.

Parameters:
attendee - the attendee
Returns:
True if the attendee was successfully removed from the collection, false otherwise.
Throws:
java.lang.Exception - the exception

createComplexProperty

protected Attendee createComplexProperty(java.lang.String xmlElementName)
* Creates an Attendee object from an XML element name.

Specified by:
createComplexProperty in class ComplexPropertyCollection<Attendee>
Parameters:
xmlElementName - the xml element name
Returns:
An Attendee object.

getCollectionItemXmlElementName

protected java.lang.String getCollectionItemXmlElementName(Attendee attendee)
* Retrieves the XML element name corresponding to the provided Attendee object.

Specified by:
getCollectionItemXmlElementName in class ComplexPropertyCollection<Attendee>
Parameters:
attendee - the attendee
Returns:
The XML element name corresponding to the provided Attendee object.