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

Class GetUserAvailabilityRequest

java.lang.Object

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

microsoft.exchange.webservices.data.core.request.SimpleServiceRequestBase<GetUserAvailabilityResults>

microsoft.exchange.webservices.data.core.request.GetUserAvailabilityRequest

public final class GetUserAvailabilityRequest
extends SimpleServiceRequestBase<GetUserAvailabilityResults>

Represents a GetUserAvailability request.

Constructor Summary

Constructors

Constructor	Description
GetUserAvailabilityRequest(ExchangeService service)	Initializes a new instance of the "GetUserAvailabilityRequest" class.

Method Summary

Modifier and Type	Method	Description
GetUserAvailabilityResults	execute()	Executes this request.
Iterable<AttendeeInfo>	getAttendees()	Gets the attendees.
protected ExchangeVersion	getMinimumRequiredServerVersion()	Gets the request version.
AvailabilityOptions	getOptions()	Gets an object that allows you to specify options controlling the information returned by the GetUserAvailability request.
AvailabilityData	getRequestedData()	Gets a value indicating what data is requested (free/busy and/or suggestions).
protected String	getResponseXmlElementName()	Gets the name of the response XML element.
TimeWindow	getTimeWindow()	Gets the time window in which to retrieve user availability information.
String	getXmlElementName()	Gets the name of the XML element.
boolean	isFreeBusyViewRequested()	Gets a value indicating whether free/busy data is requested.
boolean	isSuggestionsViewRequested()	Gets a value indicating whether suggestions are requested.
protected GetUserAvailabilityResults	parseResponse(EwsServiceXmlReader reader)	Parses the response.
void	setAttendees(Iterable<AttendeeInfo> attendees)	Sets the attendees.
void	setOptions(AvailabilityOptions options)	Sets the options.
void	setRequestedData(AvailabilityData requestedData)	Sets the requested data.
void	setTimeWindow(TimeWindow timeWindow)	Sets the time window.
protected void	validate()	Validate request.
protected void	writeElementsToXml(EwsServiceXmlWriter writer)	Writes XML elements.

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

GetUserAvailabilityRequest

public GetUserAvailabilityRequest(ExchangeService service)
                           throws Exception

Initializes a new instance of the "GetUserAvailabilityRequest" class.

Parameters:

service - the service

Throws:

Exception

Method Detail

getXmlElementName

public String getXmlElementName()

Gets the name of the XML element.

Specified by:

getXmlElementName in class ServiceRequestBase<GetUserAvailabilityResults>

Returns:

XML element name.

isFreeBusyViewRequested

public boolean isFreeBusyViewRequested()

Gets a value indicating whether free/busy data is requested.

Returns:

true, if is free busy view requested

isSuggestionsViewRequested

public boolean isSuggestionsViewRequested()

Gets a value indicating whether suggestions are requested.

Returns:

true, if is suggestions view requested

validate

protected void validate()
                 throws Exception

Validate request.

Overrides:

validate in class ServiceRequestBase<GetUserAvailabilityResults>

Throws:

Exception - the exception

writeElementsToXml

protected void writeElementsToXml(EwsServiceXmlWriter writer)
                           throws Exception

Writes XML elements.

Specified by:

writeElementsToXml in class ServiceRequestBase<GetUserAvailabilityResults>

Parameters:

writer - the writer

Throws:

Exception - the exception

getResponseXmlElementName

protected String getResponseXmlElementName()

Gets the name of the response XML element.

Specified by:

getResponseXmlElementName in class ServiceRequestBase<GetUserAvailabilityResults>

Returns:

XML element name

parseResponse

protected GetUserAvailabilityResults parseResponse(EwsServiceXmlReader reader)
                                            throws Exception

Parses the response.

Specified by:

parseResponse in class ServiceRequestBase<GetUserAvailabilityResults>

Parameters:

reader - The reader.

Returns:

the Response Object.

Throws:

Exception - the exception

getMinimumRequiredServerVersion

protected ExchangeVersion getMinimumRequiredServerVersion()

Gets the request version.

Specified by:

getMinimumRequiredServerVersion in class ServiceRequestBase<GetUserAvailabilityResults>

Returns:

Earliest Exchange version in which this request is supported.

execute

public GetUserAvailabilityResults execute()
                                   throws Exception

Executes this request.

Returns:

Service response.

Throws:

Exception - the exception

getAttendees

public Iterable<AttendeeInfo> getAttendees()

Gets the attendees.

Returns:

the attendees

setAttendees

public void setAttendees(Iterable<AttendeeInfo> attendees)

Sets the attendees.

Parameters:

attendees - the new attendees

getTimeWindow

public TimeWindow getTimeWindow()

Gets the time window in which to retrieve user availability information.

Returns:

the time window

setTimeWindow

public void setTimeWindow(TimeWindow timeWindow)

Sets the time window.

Parameters:

timeWindow - the new time window

getRequestedData

public AvailabilityData getRequestedData()

Gets a value indicating what data is requested (free/busy and/or suggestions).

Returns:

the requested data

setRequestedData

public void setRequestedData(AvailabilityData requestedData)

Sets the requested data.

Parameters:

requestedData - the new requested data

getOptions

public AvailabilityOptions getOptions()

Gets an object that allows you to specify options controlling the information returned by the GetUserAvailability request.

Returns:

the options

setOptions

public void setOptions(AvailabilityOptions options)

Sets the options.

Parameters:

options - the new options