microsoft.exchange.webservices.data.core.request
Class CreateResponseObjectRequest

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

public final class CreateResponseObjectRequest
extends MultiResponseServiceRequest<TResponse>

Represents a CreateItem request for a response object.

Constructor Summary

CreateResponseObjectRequest(ExchangeService service, ServiceErrorHandling errorHandlingMode)
Initializes a new instance of the CreateResponseObjectRequest class.

Method Summary

protected CreateResponseObjectResponse	createServiceResponse(ExchangeService service, int responseIndex) Creates the service response.
protected int	getExpectedResponseMessageCount() Gets the expected response message count.
Iterable<TServiceObject>	getItems() Gets the item.
MessageDisposition	getMessageDisposition() Gets the message disposition.
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.
SendInvitationsMode	getSendInvitationsMode() Gets the send invitations mode.
String	getXmlElementName() Gets the name of the XML element.
void	setItems(Collection<TServiceObject> value) Gets the item.
void	setMessageDisposition(MessageDisposition value) Sets the message disposition.
protected void	setObjects(Collection<TServiceObject> value) Sets the service objects.
void	setParentFolderId(FolderId value) Sets the parent folder id.
void	setSendInvitationsMode(SendInvitationsMode value) Sets the send invitations mode.
protected void	validate() Validate the request.
protected void	writeAttributesToXml(EwsServiceXmlWriter writer) Writes the attribute to XML.
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, writeBodyToXml, writeToXml

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateResponseObjectRequest

public CreateResponseObjectRequest(ExchangeService service,
                                   ServiceErrorHandling errorHandlingMode)
                            throws Exception

Initializes a new instance of the CreateResponseObjectRequest class.

Parameters:

service - The Service

errorHandlingMode - Indicates how errors should be handled.

Throws:

Exception

Method Detail

createServiceResponse

protected CreateResponseObjectResponse createServiceResponse(ExchangeService service,
                                                             int responseIndex)

Creates the service response.

Specified by:

createServiceResponse in class MultiResponseServiceRequest<CreateResponseObjectResponse>

Parameters:

service - the service

responseIndex - the response index

Returns:

Service object.

getMinimumRequiredServerVersion

protected ExchangeVersion getMinimumRequiredServerVersion()

Gets the request version.

Specified by:

getMinimumRequiredServerVersion in class ServiceRequestBase<ServiceResponseCollection<CreateResponseObjectResponse>>

Returns:

Earliest Exchange version in which this request is supported.

validate

protected void validate()
                 throws Exception

Validate the request.

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. XML element name.

Specified by:

getResponseMessageXmlElementName in class MultiResponseServiceRequest<TResponse extends ServiceResponse>

Returns:

the response message 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.

writeAttributesToXml

protected void writeAttributesToXml(EwsServiceXmlWriter writer)
                             throws ServiceXmlSerializationException

Writes the attribute to XML.

Overrides:

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

Parameters:

writer - The writer.

Throws:

ServiceXmlSerializationException - the service xml serialization exception

getMessageDisposition

public MessageDisposition getMessageDisposition()

Gets the message disposition.

Returns:

the message disposition

setMessageDisposition

public void setMessageDisposition(MessageDisposition value)

Sets the message disposition.

Parameters:

value - the new message disposition

getSendInvitationsMode

public SendInvitationsMode getSendInvitationsMode()

Gets the send invitations mode.

Returns:

the send invitations mode

setSendInvitationsMode

public void setSendInvitationsMode(SendInvitationsMode value)

Sets the send invitations mode.

Parameters:

value - the new send invitations mode

setItems

public void setItems(Collection<TServiceObject> value)

Gets the item.

Parameters:

value - the new item

getItems

public Iterable<TServiceObject> getItems()

Gets the item.

Returns:

the item

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

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.