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

Class CreateFolderRequest

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.CreateFolderRequest

public final class CreateFolderRequest
extends MultiResponseServiceRequest<TResponse>

Represents a CreateFolder request.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected ServiceResponse	createServiceResponse(ExchangeService service, int responseIndex)	Creates the service response.
protected int	getExpectedResponseMessageCount()	Gets the expected response message count.
Iterable<Folder>	getFolders()	Gets the folder.
protected ExchangeVersion	getMinimumRequiredServerVersion()	Gets the request version.
protected String	getObjectCollectionXmlElementName()	Gets the name of the object collection XML element.
protected Iterable<TServiceObject>	getObjects()	Gets the service objects.
FolderId	getParentFolderId()	Gets the parent folder id.
protected String	getParentFolderXmlElementName()	Gets the name of the parent folder XML element.
protected String	getResponseMessageXmlElementName()	Gets the name of the response message XML element.
protected String	getResponseXmlElementName()	Gets the name of the response XML element.
String	getXmlElementName()	Gets the name of the XML element.
void	setFolders(Iterable<Folder> folder)	Sets the folder.
protected void	setObjects(Collection<TServiceObject> value)	Sets the service objects.
void	setParentFolderId(FolderId value)	Sets the parent folder id.
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

CreateFolderRequest

public CreateFolderRequest(ExchangeService service,
                           ServiceErrorHandling errorHandlingMode)
                    throws Exception

Initializes a new instance of the CreateFolderRequest class.

Parameters:

service - The service

errorHandlingMode - Indicates how errors should be handled.

Throws:

Exception

Method Detail

validate

protected void validate()
                 throws Exception

Validate request.

Throws:

Exception - the exception

createServiceResponse

protected ServiceResponse createServiceResponse(ExchangeService service,
                                                int responseIndex)

Creates the service response.

Specified by:

createServiceResponse in class MultiResponseServiceRequest<ServiceResponse>

Parameters:

service - the service

responseIndex - Index of the response.

Returns:

Service response.

getXmlElementName

public String getXmlElementName()

Gets the name of the XML element.

Specified by:

getXmlElementName in class ServiceRequestBase<ServiceResponseCollection<ServiceResponse>>

Returns:

Xml element name

getResponseXmlElementName

protected String getResponseXmlElementName()

Gets the name of the response XML element.

Specified by:

getResponseXmlElementName in class ServiceRequestBase<ServiceResponseCollection<ServiceResponse>>

Returns:

Xml element name

getResponseMessageXmlElementName

protected String getResponseMessageXmlElementName()

Gets the name of the response message XML element.

Specified by:

getResponseMessageXmlElementName in class MultiResponseServiceRequest<ServiceResponse>

Returns:

Xml element name

getParentFolderXmlElementName

protected String getParentFolderXmlElementName()

Gets the name of the parent folder XML element.

Returns:

Xml element name

getObjectCollectionXmlElementName

protected String getObjectCollectionXmlElementName()

Gets the name of the object collection XML element.

Returns:

Xml element name

getMinimumRequiredServerVersion

protected ExchangeVersion getMinimumRequiredServerVersion()

Gets the request version. Earliest Exchange version in which this request is supported.

Specified by:

getMinimumRequiredServerVersion in class ServiceRequestBase<ServiceResponseCollection<ServiceResponse>>

Returns:

the minimum required server version

getFolders

public Iterable<Folder> getFolders()

Gets the folder.

Returns:

the folder

setFolders

public void setFolders(Iterable<Folder> folder)

Sets the folder.

Parameters:

folder - the new folder

getExpectedResponseMessageCount

protected int getExpectedResponseMessageCount()

Gets the expected response message count.

Specified by:

getExpectedResponseMessageCount in class MultiResponseServiceRequest<TResponse extends ServiceResponse>

Returns:

the expected response message count

writeElementsToXml

protected void writeElementsToXml(EwsServiceXmlWriter writer)
                           throws Exception

Description copied from class: ServiceRequestBase

Writes XML elements.

Specified by:

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

Parameters:

writer - The writer.

Throws:

Exception - the exception

getObjects

protected Iterable<TServiceObject> getObjects()

Gets the service objects.

Returns:

Iterator

setObjects

protected void setObjects(Collection<TServiceObject> value)

Sets the service objects.

Parameters:

value -

getParentFolderId

public FolderId getParentFolderId()

Gets the parent folder id.

Returns:

FolderId.

setParentFolderId

public void setParentFolderId(FolderId value)

Sets the parent folder id.

Parameters:

value - FolderId.