microsoft.exchange.webservices.data.misc.availability

Class AvailabilityOptions

java.lang.Object

microsoft.exchange.webservices.data.misc.availability.AvailabilityOptions

public final class AvailabilityOptions
extends Object

Represents the options of a GetAvailability request.

Constructor Summary

Constructors

Constructor and Description
AvailabilityOptions() Initializes a new instance of the AvailabilityOptions class.

Method Summary

Modifier and Type	Method and Description
Date	getCurrentMeetingTime() Gets the start time of a meeting that you want to update with the suggested meeting times.
TimeWindow	getDetailedSuggestionsWindow() Gets the time window for which detailed information about suggested meeting times should be returned.
String	getGlobalObjectId() Gets the global object Id of a meeting that will be modified based on the data returned by GetUserAvailability.
int	getGoodSuggestionThreshold() Gets the percentage of attendees that must have the time period open for the time period to qualify as a good suggested meeting time.
int	getMaximumNonWorkHoursSuggestionsPerDay() Gets the number of suggested meeting times outside regular working hours per day.
int	getMaximumSuggestionsPerDay() Gets the number of suggested meeting times that should be returned per day.
int	getMeetingDuration() Gets the duration, in minutes, of the meeting for which to obtain suggestions.
int	getMergedFreeBusyInterval() Gets the time difference between two successive slots in a FreeBusyMerged view.
SuggestionQuality	getMinimumSuggestionQuality() Gets the minimum quality of suggestions that should be returned.
FreeBusyViewType	getRequestedFreeBusyView() Gets the requested type of free/busy view.
void	setCurrentMeetingTime(Date value) Sets the current meeting time.
void	setDetailedSuggestionsWindow(TimeWindow value) Sets the detailed suggestions window.
void	setGlobalObjectId(String value) Sets the global object id.
void	setGoodSuggestionThreshold(int value) Sets the good suggestion threshold.
void	setMaximumNonWorkHoursSuggestionsPerDay(int value) Sets the maximum non work hours suggestions per day.
void	setMaximumSuggestionsPerDay(int value) Sets the maximum suggestions per day.
void	setMeetingDuration(int value) Sets the meeting duration.
void	setMergedFreeBusyInterval(int value) Sets the merged free busy interval.
void	setMinimumSuggestionQuality(SuggestionQuality value) Sets the minimum suggestion quality.
void	setRequestedFreeBusyView(FreeBusyViewType value) Sets the requested free busy view.
void	validate(long timeWindow) Validates this instance against the specified time window.
void	writeToXml(EwsServiceXmlWriter writer, GetUserAvailabilityRequest request) Writes to XML.

Methods inherited from class java.lang.Object

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

Constructor Detail

AvailabilityOptions

public AvailabilityOptions()

Initializes a new instance of the AvailabilityOptions class.

Method Detail

validate

public void validate(long timeWindow)
              throws Exception

Validates this instance against the specified time window.

Parameters:

timeWindow - the time window

Throws:

Exception - the exception

writeToXml

public void writeToXml(EwsServiceXmlWriter writer,
                       GetUserAvailabilityRequest request)
                throws Exception

Writes to XML.

Parameters:

writer - the writer

request - the request

Throws:

Exception - the exception

getMergedFreeBusyInterval

public int getMergedFreeBusyInterval()

Gets the time difference between two successive slots in a FreeBusyMerged view. MergedFreeBusyInterval must be between 5 and 1440. The default value is 30.

Returns:

the merged free busy interval

setMergedFreeBusyInterval

public void setMergedFreeBusyInterval(int value)

Sets the merged free busy interval.

Parameters:

value - the new merged free busy interval

getRequestedFreeBusyView

public FreeBusyViewType getRequestedFreeBusyView()

Gets the requested type of free/busy view. The default value is FreeBusyViewType.Detailed.

Returns:

the requested free busy view

setRequestedFreeBusyView

public void setRequestedFreeBusyView(FreeBusyViewType value)

Sets the requested free busy view.

Parameters:

value - the new requested free busy view

getGoodSuggestionThreshold

public int getGoodSuggestionThreshold()

Gets the percentage of attendees that must have the time period open for the time period to qualify as a good suggested meeting time. GoodSuggestionThreshold must be between 1 and 49. The default value is 25.

Returns:

the good suggestion threshold

setGoodSuggestionThreshold

public void setGoodSuggestionThreshold(int value)

Sets the good suggestion threshold.

Parameters:

value - the new good suggestion threshold

getMaximumSuggestionsPerDay

public int getMaximumSuggestionsPerDay()

Gets the number of suggested meeting times that should be returned per day. MaximumSuggestionsPerDay must be between 0 and 48. The default value is 10.

Returns:

the maximum suggestions per day

setMaximumSuggestionsPerDay

public void setMaximumSuggestionsPerDay(int value)

Sets the maximum suggestions per day.

Parameters:

value - the new maximum suggestions per day

getMaximumNonWorkHoursSuggestionsPerDay

public int getMaximumNonWorkHoursSuggestionsPerDay()

Gets the number of suggested meeting times outside regular working hours per day. MaximumNonWorkHoursSuggestionsPerDay must be between 0 and 48. The default value is 0.

Returns:

the maximum non work hours suggestions per day

setMaximumNonWorkHoursSuggestionsPerDay

public void setMaximumNonWorkHoursSuggestionsPerDay(int value)

Sets the maximum non work hours suggestions per day.

Parameters:

value - the new maximum non work hours suggestions per day

getMeetingDuration

public int getMeetingDuration()

Gets the duration, in minutes, of the meeting for which to obtain suggestions. MeetingDuration must be between 30 and 1440. The default value is 60.

Returns:

the meeting duration

setMeetingDuration

public void setMeetingDuration(int value)

Sets the meeting duration.

Parameters:

value - the new meeting duration

getMinimumSuggestionQuality

public SuggestionQuality getMinimumSuggestionQuality()

Gets the minimum quality of suggestions that should be returned. The default is SuggestionQuality.Fair.

Returns:

the minimum suggestion quality

setMinimumSuggestionQuality

public void setMinimumSuggestionQuality(SuggestionQuality value)

Sets the minimum suggestion quality.

Parameters:

value - the new minimum suggestion quality

getDetailedSuggestionsWindow

public TimeWindow getDetailedSuggestionsWindow()

Gets the time window for which detailed information about suggested meeting times should be returned.

Returns:

the detailed suggestions window

setDetailedSuggestionsWindow

public void setDetailedSuggestionsWindow(TimeWindow value)

Sets the detailed suggestions window.

Parameters:

value - the new detailed suggestions window

getCurrentMeetingTime

public Date getCurrentMeetingTime()

Gets the start time of a meeting that you want to update with the suggested meeting times.

Returns:

the current meeting time

setCurrentMeetingTime

public void setCurrentMeetingTime(Date value)

Sets the current meeting time.

Parameters:

value - the new current meeting time

getGlobalObjectId

public String getGlobalObjectId()

Gets the global object Id of a meeting that will be modified based on the data returned by GetUserAvailability.

Returns:

the global object id

setGlobalObjectId

public void setGlobalObjectId(String value)

Sets the global object id.

Parameters:

value - the new global object id