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

Class CreateAttachmentRequest

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<CreateAttachmentResponse>

microsoft.exchange.webservices.data.core.request.CreateAttachmentRequest

public final class CreateAttachmentRequest
extends MultiResponseServiceRequest<CreateAttachmentResponse>

Represents a CreateAttachment request.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected CreateAttachmentResponse	createServiceResponse(ExchangeService service, int responseIndex)	Creates the service response.
protected boolean	emitTimeZoneHeader()	Gets a value indicating whether the TimeZoneContext SOAP header should be emitted.
ArrayList<Attachment>	getAttachments()	Gets the attachments.
protected int	getExpectedResponseMessageCount()	Gets the expected response message count.
protected ExchangeVersion	getMinimumRequiredServerVersion()	Gets the request version.
String	getParentItemId()	Gets the parent item id.
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	setParentItemId(String parentItemId)	Sets the parent item id.
protected void	validate()	Validate request..
protected void	writeElementsToXml(EwsServiceXmlWriter writer)	Writes the elements to XML.

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

CreateAttachmentRequest

public CreateAttachmentRequest(ExchangeService service,
                               ServiceErrorHandling errorHandlingMode)
                        throws Exception

Initializes a new instance of the class.

Parameters:

service - the service

errorHandlingMode - the error handling mode

Throws:

Exception

Method Detail

getAttachments

public ArrayList<Attachment> getAttachments()

Gets the attachments.

Returns:

attachments

validate

protected void validate()
                 throws Exception

Validate request..

Overrides:

validate in class ServiceRequestBase<ServiceResponseCollection<CreateAttachmentResponse>>

Throws:

Exception - the exception

getExpectedResponseMessageCount

protected int getExpectedResponseMessageCount()

Gets the expected response message count.

Specified by:

getExpectedResponseMessageCount in class MultiResponseServiceRequest<CreateAttachmentResponse>

Returns:

Number of expected response messages.

getXmlElementName

public String getXmlElementName()

Gets the name of the XML element.

Specified by:

getXmlElementName in class ServiceRequestBase<ServiceResponseCollection<CreateAttachmentResponse>>

Returns:

XML element name.

getResponseXmlElementName

protected String getResponseXmlElementName()

Gets the name of the response XML element.

Specified by:

getResponseXmlElementName in class ServiceRequestBase<ServiceResponseCollection<CreateAttachmentResponse>>

Returns:

XML element name.

getResponseMessageXmlElementName

protected String getResponseMessageXmlElementName()

Gets the name of the response message XML element.

Specified by:

getResponseMessageXmlElementName in class MultiResponseServiceRequest<CreateAttachmentResponse>

Returns:

XML element name.

getMinimumRequiredServerVersion

protected ExchangeVersion getMinimumRequiredServerVersion()

Gets the request version.

Specified by:

getMinimumRequiredServerVersion in class ServiceRequestBase<ServiceResponseCollection<CreateAttachmentResponse>>

Returns:

Earliest Exchange version in which this request is supported.

emitTimeZoneHeader

protected boolean emitTimeZoneHeader()
                              throws ServiceLocalException,
                                     Exception

Gets a value indicating whether the TimeZoneContext SOAP header should be emitted.

Throws:

ServiceLocalException

Exception

getParentItemId

public String getParentItemId()

Gets the parent item id.

Returns:

parentItemId

setParentItemId

public void setParentItemId(String parentItemId)

Sets the parent item id.

Parameters:

parentItemId - the new parent item id

writeElementsToXml

protected void writeElementsToXml(EwsServiceXmlWriter writer)
                           throws Exception

Writes the elements to XML.

Specified by:

writeElementsToXml in class ServiceRequestBase<ServiceResponseCollection<CreateAttachmentResponse>>

Parameters:

writer - the writer

Throws:

Exception - the exception

createServiceResponse

protected CreateAttachmentResponse createServiceResponse(ExchangeService service,
                                                         int responseIndex)

Creates the service response.

Specified by:

createServiceResponse in class MultiResponseServiceRequest<CreateAttachmentResponse>

Parameters:

service - the service

responseIndex - the response index

Returns:

the creates the attachment response