microsoft.exchange.webservices.data
Class FolderPermissionCollection

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

public final class FolderPermissionCollection
extends ComplexPropertyCollection<FolderPermission>

Represents a collection of folder permissions.


Constructor Summary
protected FolderPermissionCollection(Folder owner)
          * Initializes a new instance of the FolderPermissionCollection class.
 
Method Summary
 void add(FolderPermission permission)
          * Adds a permission to the collection.
 void addFolderRange(java.util.Iterator<FolderPermission> permissions)
          * Adds the specified permissions to the collection.
 void clear()
          Clears this collection.
protected  FolderPermission createComplexProperty(java.lang.String xmlElementName)
          * Creates the complex property.
protected  java.lang.String getCollectionItemXmlElementName(FolderPermission complexProperty)
          * Gets the name of the collection item XML element.
 java.util.Collection<java.lang.String> getUnknownEntries()
          * Gets a list of unknown user Ids in the collection.
protected  void loadFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader, java.lang.String localElementName)
          * Loads from XML.
 boolean remove(FolderPermission permission)
          * Removes a permission from the collection.
 void removeAt(int index)
          * Removes a permission from the collection.
 void validate()
          Validates this instance.
protected  void writeElementsToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
          * Writes the elements to XML.
 
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, removeFromChangeLog, shouldWriteToXml, updateFromXml, writeDeleteUpdateToXml, 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, writeAttributesToXml, writeToXml
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FolderPermissionCollection

protected FolderPermissionCollection(Folder owner)
* Initializes a new instance of the FolderPermissionCollection class.

Parameters:
owner - the owner
Method Detail

getCollectionItemXmlElementName

protected java.lang.String getCollectionItemXmlElementName(FolderPermission complexProperty)
* Gets the name of the collection item XML element.

Specified by:
getCollectionItemXmlElementName in class ComplexPropertyCollection<FolderPermission>
Parameters:
complexProperty - the complex property
Returns:
the collection item xml element name

loadFromXml

protected void loadFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader,
                           java.lang.String localElementName)
                    throws java.lang.Exception
* Loads from XML.

Overrides:
loadFromXml in class ComplexPropertyCollection<FolderPermission>
Parameters:
reader - the reader
localElementName - the local element name
Throws:
java.lang.Exception - the exception

validate

public void validate()
Validates this instance.

Overrides:
validate in class ComplexProperty

writeElementsToXml

protected void writeElementsToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
                           throws java.lang.Exception
* Writes the elements to XML.

Overrides:
writeElementsToXml in class ComplexPropertyCollection<FolderPermission>
Parameters:
writer - the writer
Throws:
java.lang.Exception - the exception

createComplexProperty

protected FolderPermission createComplexProperty(java.lang.String xmlElementName)
* Creates the complex property.

Specified by:
createComplexProperty in class ComplexPropertyCollection<FolderPermission>
Parameters:
xmlElementName - the xml element name
Returns:
FolderPermission instance.

add

public void add(FolderPermission permission)
* Adds a permission to the collection.

Parameters:
permission - the permission

addFolderRange

public void addFolderRange(java.util.Iterator<FolderPermission> permissions)
                    throws java.lang.Exception
* Adds the specified permissions to the collection.

Parameters:
permissions - the permissions
Throws:
java.lang.Exception - the exception

clear

public void clear()
Clears this collection.


remove

public boolean remove(FolderPermission permission)
* Removes a permission from the collection.

Parameters:
permission - the permission
Returns:
True if the folder permission was successfully removed from the collection, false otherwise.

removeAt

public void removeAt(int index)
* Removes a permission from the collection.

Parameters:
index - the index

getUnknownEntries

public java.util.Collection<java.lang.String> getUnknownEntries()
* Gets a list of unknown user Ids in the collection.

Returns:
the unknown entries