Package microsoft.exchange.webservices.data.core.request

Class GetFolderRequest

java.lang.Object

microsoft.exchange.webservices.data.core.request.ServiceRequestBase<T>

microsoft.exchange.webservices.data.core.request.SimpleServiceRequestBase<ServiceResponseCollection<TResponse>>

microsoft.exchange.webservices.data.core.request.MultiResponseServiceRequest<TResponse>

microsoft.exchange.webservices.data.core.request.GetFolderRequest

public final class GetFolderRequest
extends MultiResponseServiceRequest<TResponse>

Represents a GetFolder request.

Constructor Summary

Constructors

Constructor	Description
GetFolderRequest(ExchangeService service, ServiceErrorHandling errorHandlingMode)	Initializes a new instance of the GetFolderRequest class.

Method Summary

Modifier and Type	Method	Description
protected GetFolderResponse	createServiceResponse(ExchangeService service, int responseIndex)	Creates the service response.
protected int	getExpectedResponseMessageCount()	Gets the expected response message count.
FolderIdWrapperList	getFolderIds()	Gets the folder ids.
protected ExchangeVersion	getMinimumRequiredServerVersion()	Gets the request version.
PropertySet	getPropertySet()	Gets the property set.
protected String	getResponseMessageXmlElementName()	Gets the name of the response message XML element.
protected String	getResponseXmlElementName()	Gets the name of the response XML element.
protected ServiceObjectType	getServiceObjectType()	Gets the type of the service object this request applies to.
String	getXmlElementName()	Gets the name of the XML element.
void	setPropertySet(PropertySet propertySet)	Sets the property set.
protected void	validate()	Validate request.
protected void	writeElementsToXml(EwsServiceXmlWriter writer)	Writes XML elements.

Methods inherited from class microsoft.exchange.webservices.data.core.request.MultiResponseServiceRequest

endExecute, execute, getErrorHandlingMode, parseResponse

Methods inherited from class microsoft.exchange.webservices.data.core.request.SimpleServiceRequestBase

beginExecute, endInternalExecute, internalExecute

Methods inherited from class microsoft.exchange.webservices.data.core.request.ServiceRequestBase

buildEwsHttpPoolingWebRequest, buildEwsHttpWebRequest, getEwsHttpWebResponse, getResponseStream, getService, processWebException, readPreamble, readResponse, readResponse, readSoapFault, throwIfNotSupportedByRequestedServerVersion, traceResponse, validateAndEmitRequest, writeAttributesToXml, writeBodyToXml, writeToXml

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GetFolderRequest

public GetFolderRequest(ExchangeService service,
                        ServiceErrorHandling errorHandlingMode)
                 throws Exception

Initializes a new instance of the GetFolderRequest class.

Parameters:

service - the service

errorHandlingMode - Indicates how errors should be handled.

Throws:

Exception

Method Detail

createServiceResponse

protected GetFolderResponse createServiceResponse(ExchangeService service,
                                                  int responseIndex)

Creates the service response.

Specified by:

createServiceResponse in class MultiResponseServiceRequest<GetFolderResponse>

Parameters:

service - The service

responseIndex - Index of the response.

Returns:

Service response.

validate

protected void validate()
                 throws Exception

Validate request.

Throws:

Exception - the exception

getExpectedResponseMessageCount

protected int getExpectedResponseMessageCount()

Gets the expected response message count.

Specified by:

getExpectedResponseMessageCount in class MultiResponseServiceRequest<TResponse extends ServiceResponse>

Returns:

Number of expected response messages

getServiceObjectType

protected ServiceObjectType getServiceObjectType()

Gets the type of the service object this request applies to.

Returns:

The type of service object the request applies to

writeElementsToXml

protected void writeElementsToXml(EwsServiceXmlWriter writer)
                           throws Exception

Writes XML elements.

Parameters:

writer - the writer

Throws:

Exception - the exception

getXmlElementName

public String getXmlElementName()

Gets the name of the XML element.

Specified by:

getXmlElementName in class ServiceRequestBase<ServiceResponseCollection<TResponse extends ServiceResponse>>

Returns:

XML element name

getResponseXmlElementName

protected String getResponseXmlElementName()

Gets the name of the response XML element.

Specified by:

getResponseXmlElementName in class ServiceRequestBase<ServiceResponseCollection<TResponse extends ServiceResponse>>

Returns:

XML element name

getResponseMessageXmlElementName

protected String getResponseMessageXmlElementName()

Gets the name of the response message XML element.

Specified by:

getResponseMessageXmlElementName in class MultiResponseServiceRequest<TResponse extends ServiceResponse>

Returns:

XML element name

getMinimumRequiredServerVersion

protected ExchangeVersion getMinimumRequiredServerVersion()

Gets the request version.

Specified by:

getMinimumRequiredServerVersion in class ServiceRequestBase<ServiceResponseCollection<TResponse extends ServiceResponse>>

Returns:

Earliest Exchange version in which this request is supported

getFolderIds

public FolderIdWrapperList getFolderIds()

Gets the folder ids.

Returns:

the folder ids

getPropertySet

public PropertySet getPropertySet()

Gets the property set.

Returns:

the property set

setPropertySet

public void setPropertySet(PropertySet propertySet)

Sets the property set.

Parameters:

propertySet - the new property set