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

Class GetEventsRequest

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

microsoft.exchange.webservices.data.core.request.GetEventsRequest

public class GetEventsRequest
extends MultiResponseServiceRequest<GetEventsResponse>

GetEvents request.

Constructor Summary

Constructors

Constructor	Description
GetEventsRequest(ExchangeService service)	Initializes a new instance.

Method Summary

Modifier and Type	Method	Description
protected GetEventsResponse	createServiceResponse(ExchangeService service, int responseIndex)	Creates the service response.
protected int	getExpectedResponseMessageCount()	Gets the expected response message count.
protected ExchangeVersion	getMinimumRequiredServerVersion()	Gets the request version.
protected String	getResponseMessageXmlElementName()	Gets the name of the response message XML element.
protected String	getResponseXmlElementName()	Gets the name of the response XML element.
String	getSubscriptionId()	gets the subscriptionId.
String	getWatermark()	gets the watermark.
String	getXmlElementName()	Gets the name of the XML element.
void	setSubscriptionId(String subscriptionId)	Sets the subscriptionId.
void	setWatermark(String watermark)	Sets the watermark.
protected void	validate()	Validates the request.
protected void	writeElementsToXml(EwsServiceXmlWriter writer)	Writes the elements to XML writer.

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

GetEventsRequest

public GetEventsRequest(ExchangeService service)
                 throws Exception

Initializes a new instance.

Parameters:

service - the service

Throws:

Exception

Method Detail

createServiceResponse

protected GetEventsResponse createServiceResponse(ExchangeService service,
                                                  int responseIndex)

Creates the service response.

Specified by:

createServiceResponse in class MultiResponseServiceRequest<GetEventsResponse>

Parameters:

service - the service

responseIndex - the response index

Returns:

Service response

getExpectedResponseMessageCount

protected int getExpectedResponseMessageCount()

Gets the expected response message count.

Specified by:

getExpectedResponseMessageCount in class MultiResponseServiceRequest<GetEventsResponse>

Returns:

Response count

getXmlElementName

public String getXmlElementName()

Gets the name of the XML element.

Specified by:

getXmlElementName in class ServiceRequestBase<ServiceResponseCollection<GetEventsResponse>>

Returns:

XML element name

getResponseXmlElementName

protected String getResponseXmlElementName()

Gets the name of the response XML element.

Specified by:

getResponseXmlElementName in class ServiceRequestBase<ServiceResponseCollection<GetEventsResponse>>

Returns:

XML element name

getResponseMessageXmlElementName

protected String getResponseMessageXmlElementName()

Gets the name of the response message XML element.

Specified by:

getResponseMessageXmlElementName in class MultiResponseServiceRequest<GetEventsResponse>

Returns:

XML element name

validate

protected void validate()
                 throws Exception

Validates the request.

Overrides:

validate in class ServiceRequestBase<ServiceResponseCollection<GetEventsResponse>>

Throws:

Exception - the exception

writeElementsToXml

protected void writeElementsToXml(EwsServiceXmlWriter writer)
                           throws XMLStreamException,
                                  ServiceXmlSerializationException

Writes the elements to XML writer.

Specified by:

writeElementsToXml in class ServiceRequestBase<ServiceResponseCollection<GetEventsResponse>>

Parameters:

writer - the writer

Throws:

XMLStreamException - the XML stream exception

ServiceXmlSerializationException - the service xml serialization exception

getMinimumRequiredServerVersion

protected ExchangeVersion getMinimumRequiredServerVersion()

Gets the request version.

Specified by:

getMinimumRequiredServerVersion in class ServiceRequestBase<ServiceResponseCollection<GetEventsResponse>>

Returns:

Earliest Exchange version in which this request is supported

getSubscriptionId

public String getSubscriptionId()

gets the subscriptionId.

Returns:

the subscriptionId.

setSubscriptionId

public void setSubscriptionId(String subscriptionId)

Sets the subscriptionId.

Parameters:

subscriptionId - the subscriptionId.

getWatermark

public String getWatermark()

gets the watermark.

Returns:

the watermark.

setWatermark

public void setWatermark(String watermark)

Sets the watermark.

Parameters:

watermark - the new watermark