|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectmicrosoft.exchange.webservices.data.ServiceObject
microsoft.exchange.webservices.data.Folder
public class Folder
Represents a generic folder.
Constructor Summary | |
---|---|
Folder(ExchangeService service)
Initializes an unsaved local instance of |
Method Summary | |
---|---|
static Folder |
bind(ExchangeService service,
FolderId id)
Binds to an existing folder, whatever its actual type is, and loads the specified set of properties. |
static Folder |
bind(ExchangeService service,
FolderId id,
PropertySet propertySet)
Binds to an existing folder, whatever its actual type is, and loads the specified set of properties. |
static Folder |
bind(ExchangeService service,
WellKnownFolderName name)
* Binds to an existing folder, whatever its actual type is, and loads the specified set of properties. |
static Folder |
bind(ExchangeService service,
WellKnownFolderName name,
PropertySet propertySet)
Binds to an existing folder, whatever its actual type is, and loads the specified set of properties. |
Folder |
copy(FolderId destinationFolderId)
Copies this folder into a specific folder. |
Folder |
copy(WellKnownFolderName destinationFolderName)
Copies this folder into the specified folder. |
void |
delete(DeleteMode deleteMode)
Deletes the folder. |
void |
empty(DeleteMode deletemode,
boolean deleteSubFolders)
Empties the folder. |
FindFoldersResults |
findFolders(FolderView view)
Obtains a list of folders by searching the sub-folders of this folder. |
FindFoldersResults |
findFolders(SearchFilter searchFilter,
FolderView view)
Obtains a list of folders by searching the sub-folders of this folder. |
FindItemsResults<Item> |
findItems(ItemView view)
Find items. |
GroupedFindItemsResults<Item> |
findItems(ItemView view,
Grouping groupBy)
Obtains a grouped list of items by searching the contents of this folder. |
FindItemsResults<Item> |
findItems(SearchFilter searchFilter,
ItemView view)
Find items. |
GroupedFindItemsResults<Item> |
findItems(SearchFilter searchFilter,
ItemView view,
Grouping groupBy)
Find items. |
FindItemsResults<Item> |
findItems(java.lang.String queryString,
ItemView view)
Find items. |
GroupedFindItemsResults<Item> |
findItems(java.lang.String queryString,
ItemView view,
Grouping groupBy)
Find items. |
protected java.lang.String |
getChangeXmlElementName()
Gets the name of the change XML element. |
int |
getChildFolderCount()
Gets the number of child folders this folder has. |
protected java.lang.String |
getDeleteFieldXmlElementName()
Gets the name of the delete field XML element. |
java.lang.String |
getDisplayName()
Gets the display name of the folder. |
java.util.EnumSet<EffectiveRights> |
getEffectiveRights()
Gets a value indicating the effective rights the current authenticated user has on the folder. |
protected ExtendedPropertyCollection |
getExtendedProperties()
True if property was removed. |
ExtendedPropertyCollection |
getExtendedPropertiesForService()
Gets a list of extended properties associated with the folder. |
java.lang.String |
getFolderClass()
Gets the custom class name of this folder. |
FolderId |
getId()
Gets the Id of the folder. |
protected PropertyDefinition |
getIdPropertyDefinition()
Get the property definition for the Id property. |
ManagedFolderInformation |
getManagedFolderInformation()
Gets the Email Lifecycle Management (ELC) information associated with the folder. |
protected ExchangeVersion |
getMinimumRequiredServerVersion()
Gets the minimum required server version. |
FolderId |
getParentFolderId()
Gets the Id of this folder's parent folder. |
FolderPermissionCollection |
getPermissions()
Gets a list of permissions for the folder. |
protected ServiceObjectSchema |
getSchema()
Internal method to return the schema associated with this type of object. |
protected java.lang.String |
getSetFieldXmlElementName()
Gets the name of the set field XML element. |
int |
getTotalCount()
Gets the total number of items contained in the folder. |
int |
getUnreadCount()
Gets the number of unread items in the folder. |
protected void |
internalDelete(DeleteMode deleteMode,
SendCancellationsMode sendCancellationsMode,
AffectedTaskOccurrence affectedTaskOccurrences)
Deletes the object. |
protected void |
internalLoad(PropertySet propertySet)
Loads the specified set of properties on the object. |
Folder |
move(FolderId destinationFolderId)
Moves this folder to a specific folder. |
Folder |
move(WellKnownFolderName destinationFolderName)
Moves this folder to a specific folder. |
boolean |
removeExtendedProperty(ExtendedPropertyDefinition extendedPropertyDefinition)
Removes an extended property. |
void |
save(FolderId parentFolderId)
Saves this folder in a specific folder. |
void |
save(WellKnownFolderName parentFolderName)
Saves this folder in a specific folder. |
void |
setDisplayName(java.lang.String value)
Sets the display name of the folder. |
void |
setExtendedProperty(ExtendedPropertyDefinition extendedPropertyDefinition,
java.lang.Object value)
Sets the extended property. |
void |
setFolderClass(java.lang.String value)
Sets the custom class name of this folder. |
void |
update()
Applies the local changes that have been made to this folder. |
protected void |
validate()
Validates this instance. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Folder(ExchangeService service) throws java.lang.Exception
service
- EWS service to which this object belongs.
java.lang.Exception
- the exceptionMethod Detail |
---|
public static Folder bind(ExchangeService service, FolderId id, PropertySet propertySet) throws java.lang.Exception
service
- The service to use to bind to the folder.id
- The Id of the folder to bind to.propertySet
- The set of properties to load.
java.lang.Exception
- the exceptionpublic static Folder bind(ExchangeService service, FolderId id) throws java.lang.Exception
service
- , The service to use to bind to the folder.id
- , The Id of the folder to bind to.
java.lang.Exception
- the exceptionpublic static Folder bind(ExchangeService service, WellKnownFolderName name, PropertySet propertySet) throws java.lang.Exception
service
- The service to use to bind to the folder.name
- The name of the folder to bind to.propertySet
- The set of properties to load.
java.lang.Exception
- the exceptionpublic static Folder bind(ExchangeService service, WellKnownFolderName name) throws java.lang.Exception
service
- The service to use to bind to the folder.name
- The name of the folder to bind to.
java.lang.Exception
- the exceptionprotected void validate() throws java.lang.Exception
validate
in class ServiceObject
java.lang.Exception
- the exceptionprotected ServiceObjectSchema getSchema()
getSchema
in class ServiceObject
protected ExchangeVersion getMinimumRequiredServerVersion()
getMinimumRequiredServerVersion
in class ServiceObject
protected java.lang.String getChangeXmlElementName()
getChangeXmlElementName
in class ServiceObject
protected java.lang.String getSetFieldXmlElementName()
getSetFieldXmlElementName
in class ServiceObject
protected java.lang.String getDeleteFieldXmlElementName()
getDeleteFieldXmlElementName
in class ServiceObject
protected void internalLoad(PropertySet propertySet) throws java.lang.Exception
internalLoad
in class ServiceObject
propertySet
- The properties to load.
java.lang.Exception
- the exceptionprotected void internalDelete(DeleteMode deleteMode, SendCancellationsMode sendCancellationsMode, AffectedTaskOccurrence affectedTaskOccurrences) throws java.lang.Exception
internalDelete
in class ServiceObject
deleteMode
- the delete modesendCancellationsMode
- Indicates whether meeting cancellation messages should be
sent.affectedTaskOccurrences
- Indicate which occurrence of a recurring task should be
deleted.
java.lang.Exception
- the exceptionpublic void delete(DeleteMode deleteMode) throws java.lang.Exception
deleteMode
- the delete mode
java.lang.Exception
- the exceptionpublic void empty(DeleteMode deletemode, boolean deleteSubFolders) throws java.lang.Exception
deletemode
- the delete mode
deleteSubFolders
- Indicates whether sub-folders should also be deleted.
java.lang.Exception
public void save(FolderId parentFolderId) throws java.lang.Exception
parentFolderId
- The Id of the folder in which to save this folder.
java.lang.Exception
- the exceptionpublic void save(WellKnownFolderName parentFolderName) throws java.lang.Exception
parentFolderName
- The name of the folder in which to save this folder.
java.lang.Exception
- the exceptionpublic void update() throws java.lang.Exception
java.lang.Exception
- the exceptionpublic Folder copy(FolderId destinationFolderId) throws java.lang.Exception
destinationFolderId
- The Id of the folder in which to copy this folder.
java.lang.Exception
- the exceptionpublic Folder copy(WellKnownFolderName destinationFolderName) throws java.lang.Exception
destinationFolderName
- The name of the folder in which to copy this folder.
java.lang.Exception
- the exceptionpublic Folder move(FolderId destinationFolderId) throws java.lang.Exception
destinationFolderId
- The Id of the folder in which to move this folder.
java.lang.Exception
- the exceptionpublic Folder move(WellKnownFolderName destinationFolderName) throws java.lang.Exception
destinationFolderName
- The name of the folder in which to move this folder.
java.lang.Exception
- the exceptionpublic FindItemsResults<Item> findItems(SearchFilter searchFilter, ItemView view) throws java.lang.Exception
searchFilter
- The search filter. Available search filter classes include
SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and
SearchFilter.SearchFilterCollectionview
- The view controlling the number of items returned.
java.lang.Exception
- the exceptionpublic FindItemsResults<Item> findItems(java.lang.String queryString, ItemView view) throws java.lang.Exception
queryString
- query string to be used for indexed searchview
- The view controlling the number of items returned.
java.lang.Exception
- the exceptionpublic FindItemsResults<Item> findItems(ItemView view) throws java.lang.Exception
view
- The view controlling the number of items returned.
java.lang.Exception
- the exceptionpublic GroupedFindItemsResults<Item> findItems(SearchFilter searchFilter, ItemView view, Grouping groupBy) throws java.lang.Exception
searchFilter
- The search filter. Available search filter classes include
SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and
SearchFilter.SearchFilterCollectionview
- The view controlling the number of items returned.groupBy
- The group by.
java.lang.Exception
- the exceptionpublic GroupedFindItemsResults<Item> findItems(java.lang.String queryString, ItemView view, Grouping groupBy) throws java.lang.Exception
queryString
- query string to be used for indexed searchview
- The view controlling the number of items returned.groupBy
- The group by.
java.lang.Exception
- the exceptionpublic FindFoldersResults findFolders(FolderView view) throws java.lang.Exception
view
- The view controlling the number of folders returned.
java.lang.Exception
- the exceptionpublic FindFoldersResults findFolders(SearchFilter searchFilter, FolderView view) throws java.lang.Exception
searchFilter
- The search filter. Available search filter classes include
SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and
SearchFilter.SearchFilterCollectionview
- The view controlling the number of folders returned.
java.lang.Exception
- the exceptionpublic GroupedFindItemsResults<Item> findItems(ItemView view, Grouping groupBy) throws java.lang.Exception
view
- The view controlling the number of folders returned.groupBy
- The grouping criteria.
java.lang.Exception
- the exceptionprotected PropertyDefinition getIdPropertyDefinition()
getIdPropertyDefinition
in class ServiceObject
public void setExtendedProperty(ExtendedPropertyDefinition extendedPropertyDefinition, java.lang.Object value) throws java.lang.Exception
extendedPropertyDefinition
- The extended property definition.value
- The value.
java.lang.Exception
- the exceptionpublic boolean removeExtendedProperty(ExtendedPropertyDefinition extendedPropertyDefinition) throws java.lang.Exception
extendedPropertyDefinition
- The extended property definition.
java.lang.Exception
- the exceptionprotected ExtendedPropertyCollection getExtendedProperties() throws java.lang.Exception
getExtendedProperties
in class ServiceObject
java.lang.Exception
- the exceptionpublic FolderId getId()
getId
in class ServiceObject
public FolderId getParentFolderId() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic int getChildFolderCount() throws java.lang.NumberFormatException, ServiceLocalException
java.lang.NumberFormatException
- the number format exception
ServiceLocalException
- the service local exceptionpublic java.lang.String getDisplayName() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setDisplayName(java.lang.String value) throws java.lang.Exception
value
- Name of the folder
java.lang.Exception
- the exceptionpublic java.lang.String getFolderClass() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setFolderClass(java.lang.String value) throws java.lang.Exception
value
- name of the folder
java.lang.Exception
- the exceptionpublic int getTotalCount() throws java.lang.NumberFormatException, ServiceLocalException
java.lang.NumberFormatException
- the number format exception
ServiceLocalException
- the service local exceptionpublic ExtendedPropertyCollection getExtendedPropertiesForService() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic ManagedFolderInformation getManagedFolderInformation() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic java.util.EnumSet<EffectiveRights> getEffectiveRights() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic FolderPermissionCollection getPermissions() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic int getUnreadCount() throws java.lang.NumberFormatException, ServiceLocalException
java.lang.NumberFormatException
- the number format exception
ServiceLocalException
- the service local exception
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |