Package org.springframework.social.google.api.calendar

Interface EventListQueryBuilder

All Superinterfaces:

ApiQueryBuilder<EventListQueryBuilder,EventPage>, QueryBuilder<EventListQueryBuilder,EventPage>

All Known Implementing Classes:

EventListQueryBuilderImpl

public interface EventListQueryBuilder
extends ApiQueryBuilder<EventListQueryBuilder,EventPage>

Constructs queries for listing the events in a calendar, following the builder pattern. The ApiQueryBuilder.getPage() method returns an EventPage containing Event instances.

See http://developers.google.com/google-apps/calendar/v3/reference/events/list for details of the parameters.

Author:

Martin Wink

Method Summary

Modifier and Type	Method	Description
EventListQueryBuilder	alwaysIncludeEmail(boolean alwaysIncludeEmail)	Specifies whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e.
EventListQueryBuilder	iCalUid(String iCalUid)	Specifies event ID in the iCalendar format to be included in the response.
EventListQueryBuilder	maxAttendees(int maxAttendees)	The maximum number of attendees to include in the response.
EventListQueryBuilder	orderBy(OrderBy orderBy)	The order of the events returned in the result.
EventListQueryBuilder	showDeleted(boolean showDeleted)	Whether to include deleted events (with status equals "cancelled") in the result.
EventListQueryBuilder	showHiddenInvitations(boolean showHiddenInvitations)	Whether to include hidden invitations in the result.
EventListQueryBuilder	singleEvents(boolean singleEvents)	Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves.
EventListQueryBuilder	timeMax(int year, int month, int day)	Upper bound (exclusive) for an event's start time to filter by.
EventListQueryBuilder	timeMax(Date timeMax)	Upper bound (exclusive) for an event's start time to filter by.
EventListQueryBuilder	timeMin(int year, int month, int day)	Lower bound (inclusive) for an event's end time to filter by.
EventListQueryBuilder	timeMin(Date timeMin)	Lower bound (inclusive) for an event's end time to filter by.
EventListQueryBuilder	timeZone(TimeZone timeZone)	Time zone used in the response.
EventListQueryBuilder	updatedMin(Date updatedMin)	Lower bound for an event's last modification time to filter by.

Methods inherited from interface org.springframework.social.google.api.query.ApiQueryBuilder

fromPage, getPage

Methods inherited from interface org.springframework.social.google.api.query.QueryBuilder

maxResultsNumber

Method Detail

alwaysIncludeEmail

EventListQueryBuilder alwaysIncludeEmail(boolean alwaysIncludeEmail)

Specifies whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is false.

Parameters:

alwaysIncludeEmail - whether to always include email.

Returns:

this EventListQueryBuilder, for refining the query.

iCalUid

EventListQueryBuilder iCalUid(String iCalUid)

Specifies event ID in the iCalendar format to be included in the response. Optional.

Parameters:

iCalUid - the event ID in the iCalendar format.

Returns:

this EventListQueryBuilder, for refining the query.

maxAttendees

EventListQueryBuilder maxAttendees(int maxAttendees)

The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

Parameters:

maxAttendees - the maximum number of attendees to include.

Returns:

this EventListQueryBuilder, for refining the query.

orderBy

EventListQueryBuilder orderBy(OrderBy orderBy)

The order of the events returned in the result. Optional. The default is an unspecified, stable order.

Parameters:

orderBy - the required order.

Returns:

this EventListQueryBuilder, for refining the query.

showDeleted

EventListQueryBuilder showDeleted(boolean showDeleted)

Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted(boolean) and singleEvents(boolean) are both false. If showDeleted(boolean) and singleEvents(boolean) are both true, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is false.

Parameters:

showDeleted - whether to include deleted events.

Returns:

this EventListQueryBuilder, for refining the query.

showHiddenInvitations

EventListQueryBuilder showHiddenInvitations(boolean showHiddenInvitations)

Whether to include hidden invitations in the result. Optional. The default is false.

Parameters:

showHiddenInvitations - whether to include hidden invitations.

Returns:

this EventListQueryBuilder, for refining the query.

singleEvents

EventListQueryBuilder singleEvents(boolean singleEvents)

Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is false.

Parameters:

singleEvents - whether to expand recurring events into single events.

Returns:

this EventListQueryBuilder, for refining the query.

timeMin

EventListQueryBuilder timeMin(Date timeMin)

Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.

Parameters:

timeMin - the detailed time.

Returns:

this EventListQueryBuilder, for refining the query.

timeMin

EventListQueryBuilder timeMin(int year,
                              int month,
                              int day)

Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.

Parameters:

year - the full year, for example 2014.

month - the month, for example 1 for January.

day - the day in the month, starting at 1.

Returns:

this EventListQueryBuilder, for refining the query.

timeMax

EventListQueryBuilder timeMax(Date timeMax)

Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.

Parameters:

timeMax - the detailed time.

Returns:

this EventListQueryBuilder, for refining the query.

timeMax

EventListQueryBuilder timeMax(int year,
                              int month,
                              int day)

Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.

Parameters:

year - the full year, for example 2014.

month - the month, for example 1 for January.

day - the day in the month, starting at 1.

Returns:

this EventListQueryBuilder, for refining the query.

updatedMin

EventListQueryBuilder updatedMin(Date updatedMin)

Lower bound for an event's last modification time to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.

Parameters:

updatedMin - the lower bound for an event's last modification time.

Returns:

this EventListQueryBuilder, for refining the query.

timeZone

EventListQueryBuilder timeZone(TimeZone timeZone)

Time zone used in the response. Optional. The default is the time zone of the calendar.

Parameters:

timeZone - the time zone.

Returns:

this EventListQueryBuilder, for refining the query.