Class FolderPermissionCollection
- java.lang.Object
-
- microsoft.exchange.webservices.data.property.complex.ComplexProperty
-
- microsoft.exchange.webservices.data.property.complex.ComplexPropertyCollection<FolderPermission>
-
- microsoft.exchange.webservices.data.property.complex.FolderPermissionCollection
-
- All Implemented Interfaces:
Iterable<FolderPermission>,ICustomXmlUpdateSerializer,ISelfValidate,ComplexFunctionDelegate<EwsServiceXmlReader>,IComplexPropertyChangedDelegate<FolderPermission>
public final class FolderPermissionCollection extends ComplexPropertyCollection<FolderPermission>
Represents a collection of folder permissions.
-
-
Constructor Summary
Constructors Constructor Description FolderPermissionCollection(Folder owner)Initializes a new instance of the FolderPermissionCollection class.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidadd(FolderPermission permission)Adds a permission to the collection.voidaddFolderRange(Iterator<FolderPermission> permissions)Adds the specified permissions to the collection.voidclear()Clears this collection.protected FolderPermissioncreateComplexProperty(String xmlElementName)Creates the complex property.protected StringgetCollectionItemXmlElementName(FolderPermission complexProperty)Gets the name of the collection item XML element.Collection<String>getUnknownEntries()Gets a list of unknown user Ids in the collection.voidloadFromXml(EwsServiceXmlReader reader, String localElementName)Loads from XML.booleanremove(FolderPermission permission)Removes a permission from the collection.voidremoveAt(int index)Removes a permission from the collection.voidvalidate()Validates this instance.voidwriteElementsToXml(EwsServiceXmlWriter writer)Writes the elements to XML.-
Methods inherited from class microsoft.exchange.webservices.data.property.complex.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.property.complex.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
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
-
-
-
Constructor Detail
-
FolderPermissionCollection
public FolderPermissionCollection(Folder owner)
Initializes a new instance of the FolderPermissionCollection class.- Parameters:
owner- the owner
-
-
Method Detail
-
getCollectionItemXmlElementName
protected String getCollectionItemXmlElementName(FolderPermission complexProperty)
Gets the name of the collection item XML element.- Specified by:
getCollectionItemXmlElementNamein classComplexPropertyCollection<FolderPermission>- Parameters:
complexProperty- the complex property- Returns:
- the collection item xml element name
-
loadFromXml
public void loadFromXml(EwsServiceXmlReader reader, String localElementName) throws Exception
Loads from XML.- Overrides:
loadFromXmlin classComplexPropertyCollection<FolderPermission>- Parameters:
reader- the readerlocalElementName- the local element name- Throws:
Exception- the exception
-
validate
public void validate()
Validates this instance.- Specified by:
validatein interfaceISelfValidate- Overrides:
validatein classComplexProperty
-
writeElementsToXml
public void writeElementsToXml(EwsServiceXmlWriter writer) throws Exception
Writes the elements to XML.- Overrides:
writeElementsToXmlin classComplexPropertyCollection<FolderPermission>- Parameters:
writer- the writer- Throws:
Exception- the exception
-
createComplexProperty
protected FolderPermission createComplexProperty(String xmlElementName)
Creates the complex property.- Specified by:
createComplexPropertyin classComplexPropertyCollection<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(Iterator<FolderPermission> permissions) throws Exception
Adds the specified permissions to the collection.- Parameters:
permissions- the permissions- Throws:
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 Collection<String> getUnknownEntries()
Gets a list of unknown user Ids in the collection.- Returns:
- the unknown entries
-
-