microsoft.exchange.webservices.data
Class SearchFolder

java.lang.Object
  extended by microsoft.exchange.webservices.data.ServiceObject
      extended by microsoft.exchange.webservices.data.Folder
          extended by microsoft.exchange.webservices.data.SearchFolder

public class SearchFolder
extends Folder

Represents a search folder.


Constructor Summary
SearchFolder(ExchangeService service)
          Initializes an unsaved local instance of the class.
 
Method Summary
static SearchFolder bind(ExchangeService service, FolderId id)
          Binds to an existing search folder and loads its first class properties.
static SearchFolder bind(ExchangeService service, FolderId id, PropertySet propertySet)
          Binds to an existing search folder and loads the specified set of properties.
static SearchFolder bind(ExchangeService service, WellKnownFolderName name)
          Binds to an existing search folder and loads the specified set of properties.
static SearchFolder bind(ExchangeService service, WellKnownFolderName name, PropertySet propertySet)
          Binds to an existing search folder and loads the specified set of properties.
protected  ExchangeVersion getMinimumRequiredServerVersion()
          Gets the minimum required server version.
protected  ServiceObjectSchema getSchema()
          Internal method to return the schema associated with this type of object.
 SearchFolderParameters getSearchParameters()
          Gets the search parameters associated with the search folder.
protected  void validate()
          Validates this instance.
 
Methods inherited from class microsoft.exchange.webservices.data.Folder
copy, copy, delete, empty, findFolders, findFolders, findItems, findItems, findItems, findItems, findItems, findItems, getChangeXmlElementName, getChildFolderCount, getDeleteFieldXmlElementName, getDisplayName, getEffectiveRights, getExtendedProperties, getExtendedPropertiesForService, getFolderClass, getId, getIdPropertyDefinition, getManagedFolderInformation, getParentFolderId, getPermissions, getSetFieldXmlElementName, getTotalCount, getUnreadCount, internalDelete, internalLoad, move, move, removeExtendedProperty, save, save, setDisplayName, setExtendedProperty, setFolderClass, update
 
Methods inherited from class microsoft.exchange.webservices.data.ServiceObject
addServiceObjectChangedEvent, changed, clearChangeLog, clearServiceObjectChangedEvent, getIsCustomDateTimeScopingRequired, getIsTimeZoneHeaderRequired, getLoadedPropertyDefinitions, getObjectFromPropertyDefinition, getPropertyBag, getService, getXmlElementName, getXmlElementNameOverride, isDirty, isNew, load, load, loadFromXml, loadFromXml, removeServiceObjectChangedEvent, schema, setService, throwIfThisIsNew, throwIfThisIsNotNew, tryGetExtendedProperty, tryGetProperty, tryGetProperty, writeToXml, writeToXmlForUpdate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SearchFolder

public SearchFolder(ExchangeService service)
             throws java.lang.Exception
Initializes an unsaved local instance of the class. To bind to an existing search folder, use SearchFolder.Bind() instead.

Parameters:
service - the service
Throws:
java.lang.Exception - the exception
Method Detail

bind

public static SearchFolder bind(ExchangeService service,
                                FolderId id,
                                PropertySet propertySet)
                         throws java.lang.Exception
Binds to an existing search folder and loads the specified set of properties. Calling this method results in a call to EWS.

Parameters:
service - the service
id - the id
propertySet - the property set
Returns:
A SearchFolder instance representing the search folder corresponding to the specified Id.
Throws:
java.lang.Exception - the exception

bind

public static SearchFolder bind(ExchangeService service,
                                FolderId id)
                         throws java.lang.Exception
Binds to an existing search folder and loads its first class properties. Calling this method results in a call to EWS.

Parameters:
service - the service
id - the id
Returns:
A SearchFolder instance representing the search folder corresponding to the specified Id.
Throws:
java.lang.Exception - the exception

bind

public static SearchFolder bind(ExchangeService service,
                                WellKnownFolderName name,
                                PropertySet propertySet)
                         throws java.lang.Exception
Binds to an existing search folder and loads the specified set of properties. Calling this method results in a call to EWS.

Parameters:
service - the service
name - the name
propertySet - the property set
Returns:
A SearchFolder instance representing the search folder with the specified name.
Throws:
java.lang.Exception - the exception

bind

public static SearchFolder bind(ExchangeService service,
                                WellKnownFolderName name)
                         throws java.lang.Exception
Binds to an existing search folder and loads the specified set of properties. Calling this method results in a call to EWS.

Parameters:
service - the service
name - the name
Returns:
A SearchFolder instance representing the search folder with the specified name.
Throws:
java.lang.Exception - the exception

getSchema

protected ServiceObjectSchema getSchema()
Internal method to return the schema associated with this type of object.

Overrides:
getSchema in class Folder
Returns:
The schema associated with this type of object.

validate

protected void validate()
                 throws java.lang.Exception
Validates this instance.

Overrides:
validate in class Folder
Throws:
java.lang.Exception - the exception

getMinimumRequiredServerVersion

protected ExchangeVersion getMinimumRequiredServerVersion()
Gets the minimum required server version.

Overrides:
getMinimumRequiredServerVersion in class Folder
Returns:
Earliest Exchange version in which this service object type is supported.

getSearchParameters

public SearchFolderParameters getSearchParameters()
                                           throws java.lang.Exception
Gets the search parameters associated with the search folder.

Returns:
the search parameters
Throws:
java.lang.Exception - the exception