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

Class EventListQueryBuilderImpl

java.lang.Object

org.springframework.social.google.api.query.impl.QueryBuilderImpl<Q,T>

org.springframework.social.google.api.query.impl.ApiQueryBuilderImpl<EventListQueryBuilder,EventPage>

org.springframework.social.google.api.calendar.impl.EventListQueryBuilderImpl

All Implemented Interfaces:

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

public class EventListQueryBuilderImpl
extends ApiQueryBuilderImpl<EventListQueryBuilder,EventPage>
implements EventListQueryBuilder

EventListQueryBuilder implementation.

Author:

Martin Wink

Field Summary

Fields inherited from class org.springframework.social.google.api.query.impl.QueryBuilderImpl

feedUrl

Constructor Summary

Constructors

Constructor	Description
EventListQueryBuilderImpl(String urlTemplate, String calendarId, Class<EventPage> type, org.springframework.web.client.RestTemplate restTemplate)

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	fromPage(String pageToken)
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 class org.springframework.social.google.api.query.impl.ApiQueryBuilderImpl

getPage

Methods inherited from class org.springframework.social.google.api.query.impl.QueryBuilderImpl

appendQueryParam, appendQueryParam, appendQueryParam, appendQueryParam, appendQueryParam, appendQueryParam, build, castThis, encode, maxResultsNumber

Methods inherited from class java.lang.Object

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

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

getPage

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

maxResultsNumber

Constructor Detail

EventListQueryBuilderImpl

public EventListQueryBuilderImpl(String urlTemplate,
                                 String calendarId,
                                 Class<EventPage> type,
                                 org.springframework.web.client.RestTemplate restTemplate)

Method Detail

fromPage

public EventListQueryBuilder fromPage(String pageToken)

Specified by:

fromPage in interface ApiQueryBuilder<EventListQueryBuilder,EventPage>

Overrides:

fromPage in class ApiQueryBuilderImpl<EventListQueryBuilder,EventPage>

timeMin

public EventListQueryBuilder timeMin(Date timeMin)

Description copied from interface: EventListQueryBuilder

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

Specified by:

timeMin in interface EventListQueryBuilder

Parameters:

timeMin - the detailed time.

Returns:

this EventListQueryBuilder, for refining the query.

timeMin

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

Description copied from interface: EventListQueryBuilder

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

Specified by:

timeMin in interface EventListQueryBuilder

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

public EventListQueryBuilder timeMax(Date timeMax)

Description copied from interface: EventListQueryBuilder

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

Specified by:

timeMax in interface EventListQueryBuilder

Parameters:

timeMax - the detailed time.

Returns:

this EventListQueryBuilder, for refining the query.

timeMax

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

Description copied from interface: EventListQueryBuilder

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

Specified by:

timeMax in interface EventListQueryBuilder

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.

orderBy

public EventListQueryBuilder orderBy(OrderBy orderBy)

Description copied from interface: EventListQueryBuilder

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

Specified by:

orderBy in interface EventListQueryBuilder

Parameters:

orderBy - the required order.

Returns:

this EventListQueryBuilder, for refining the query.

singleEvents

public EventListQueryBuilder singleEvents(boolean singleEvents)

Description copied from interface: EventListQueryBuilder

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.

Specified by:

singleEvents in interface EventListQueryBuilder

Parameters:

singleEvents - whether to expand recurring events into single events.

Returns:

this EventListQueryBuilder, for refining the query.

showDeleted

public EventListQueryBuilder showDeleted(boolean showDeleted)

Description copied from interface: EventListQueryBuilder

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 EventListQueryBuilder.showDeleted(boolean) and EventListQueryBuilder.singleEvents(boolean) are both false. If EventListQueryBuilder.showDeleted(boolean) and EventListQueryBuilder.singleEvents(boolean) are both true, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is false.

Specified by:

showDeleted in interface EventListQueryBuilder

Parameters:

showDeleted - whether to include deleted events.

Returns:

this EventListQueryBuilder, for refining the query.

showHiddenInvitations

public EventListQueryBuilder showHiddenInvitations(boolean showHiddenInvitations)

Description copied from interface: EventListQueryBuilder

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

Specified by:

showHiddenInvitations in interface EventListQueryBuilder

Parameters:

showHiddenInvitations - whether to include hidden invitations.

Returns:

this EventListQueryBuilder, for refining the query.

timeZone

public EventListQueryBuilder timeZone(TimeZone timeZone)

Description copied from interface: EventListQueryBuilder

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

Specified by:

timeZone in interface EventListQueryBuilder

Parameters:

timeZone - the time zone.

Returns:

this EventListQueryBuilder, for refining the query.

updatedMin

public EventListQueryBuilder updatedMin(Date updatedMin)

Description copied from interface: EventListQueryBuilder

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.

Specified by:

updatedMin in interface EventListQueryBuilder

Parameters:

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

Returns:

this EventListQueryBuilder, for refining the query.

alwaysIncludeEmail

public EventListQueryBuilder alwaysIncludeEmail(boolean alwaysIncludeEmail)

Description copied from interface: EventListQueryBuilder

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.

Specified by:

alwaysIncludeEmail in interface EventListQueryBuilder

Parameters:

alwaysIncludeEmail - whether to always include email.

Returns:

this EventListQueryBuilder, for refining the query.

iCalUid

public EventListQueryBuilder iCalUid(String iCalUid)

Description copied from interface: EventListQueryBuilder

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

Specified by:

iCalUid in interface EventListQueryBuilder

Parameters:

iCalUid - the event ID in the iCalendar format.

Returns:

this EventListQueryBuilder, for refining the query.

maxAttendees

public EventListQueryBuilder maxAttendees(int maxAttendees)

Description copied from interface: EventListQueryBuilder

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.

Specified by:

maxAttendees in interface EventListQueryBuilder

Parameters:

maxAttendees - the maximum number of attendees to include.

Returns:

this EventListQueryBuilder, for refining the query.