public class

CalendarQuery

extends Query

java.lang.Object
↳	com.google.gdata.client.Query
	↳	com.google.gdata.client.calendar.CalendarQuery

Class Overview

The CalendarQuery class extends the base GData Query class to define convenience APIs for Calendar custom query parameters.

Summary

Nested Classes
class	CalendarQuery.ExtendedPropertyMatch	The ExtendedPropertyMatch class corresponds to a single extended property match.

Constants
String	EXT_PROP_QUERY	The name of the extended property query parameter that specifies that all events' extended properties must have matching values.
String	MAXIMUM_START_TIME	The name of the custom query parameter that specifies that all events returned must be less than the specified time.
String	MINIMUM_START_TIME	The name of the custom query parameter that specifies that all events returned must be greater than or equal to the specified time.

[Expand]

Inherited Constants

From class com.google.gdata.client.Query

Fields
private static final ExtendedPropertyMatch[]	EMPTY_EXT_PROP_MATCH	An empty array of ExtendedPropertyMatch which will be returned from `getExtendedPropertyQuery()` should the current extended property query be empty.

[Expand]

Inherited Fields

From class com.google.gdata.client.Query

private String	author	Author name or e-mail address for matched entries.
private List<Query.CategoryFilter>	categoryFilters	The list of category filters associate with the query.
private List<Query.CustomParameter>	customParameters	The list of custom parameters associated with the query.
private URL	feedUrl	Base feed URL against which the query will be applied.
private String	fields	Fields partial selection query parameter
private int	maxResults	The maximum number of results to return for the query.
private DateTime	publishedMax	Maximum published timestamp for matched entries.
private DateTime	publishedMin	Minimum published timestamp for matched entries.
private String	queryString	Full-text search query string.
private Query.ResultFormat	resultFormat	The expected result format for the query.
private int	startIndex	The start index for query results.
private boolean	strict	The strictness of the query parameter parsing on the server.
private DateTime	updatedMax	Maximum updated timestamp for matched entries.
private DateTime	updatedMin	Minimum updated timestamp for matched entries.

Public Constructors
	CalendarQuery(URL feedUrl) Constructs a new CalendarQuery object that targets a feed.

Public Methods
ExtendedPropertyMatch[]	getExtendedPropertyQuery() Returns an array of extended property matches parsed from the current value of `extq` custom parameter.
DateTime	getMaximumStartTime() Returns the maximum start time for events returned by the query.
DateTime	getMinimumStartTime() Returns the minimum start time for events returned by the query.
void	setExtendedPropertyQuery(ExtendedPropertyMatch... matches) Sets up the extended property matching for events returned by the query by setting the `extq` custom parameter value.
void	setMaximumStartTime(DateTime maxStart) Sets the maximum start time for events returned by the query.
void	setMinimumStartTime(DateTime minStart) Sets the minimum start time for events returned by the query.

[Expand]

Inherited Methods

From class com.google.gdata.client.Query

void	addCategoryFilter(Query.CategoryFilter categoryFilter) Adds a new CategoryFilter to the query.
void	addCustomParameter(Query.CustomParameter customParameter) Adds a new CustomParameter.
void	appendQueryParameter(StringBuilder queryBuf, String paramName, String paramValue) Appends specified query (parameter, value) to provided query URL buffer.
String	getAuthor() Returns the author name or email address used for the query.
List<Query.CategoryFilter>	getCategoryFilters() Returns the current list of CategoryFilters associated with the query.
List<Query.CustomParameter>	getCustomParameters() Returns the list of custom parameters.
List<Query.CustomParameter>	getCustomParameters(String name) Returns the list of custom parameters that match a specified name.
URL	getFeedUrl() Returns the feed URL of this query.
String	getFields() Returns the fields query string that will be used for the query.
String	getFullTextQuery() Returns the full text query string that will be used for the query.
final Integer	getIntegerCustomParameter(String name) Gets an existing Integer custom paramter, with null signifying that the parameter is not specified or not an integer.
int	getMaxResults() Returns the maximum number of results to return for the query, or `UNDEFINED` if max results has not been set.
DateTime	getPublishedMax() Returns the maximum published timestamp used for this query.
DateTime	getPublishedMin() Returns the minimum published timestamp used for this query.
URI	getQueryUri() Returns the relative query URI that represents only the query parameters without any components related to the target feed.
Query.ResultFormat	getResultFormat() Returns the query result format.
int	getStartIndex() Returns the current start index value for the query, or `UNDEFINED` if start index has not been set.
final String	getStringCustomParameter(String name) Gets an existing String custom parameter, with null signifying that the parameter is not specified.
DateTime	getUpdatedMax() Returns the maximum updated timestamp used for this query.
DateTime	getUpdatedMin() Returns the minimum updated timestamp used for this query.
URL	getUrl() Returns the Query URL that encapsulates the current state of this query object.
boolean	isStrict() Returns the strictness setting for query parameter parsing on the server.
boolean	isValidState() Check if current query state is supported.
void	setAuthor(String author) Sets the author name or email address used for the query.
void	setFields(String fields) Sets the "fields" partial selection query parameter.
void	setFullTextQuery(String query) Sets the full text query string that will be used for the query.
final void	setIntegerCustomParameter(String name, Integer value) Sets an integer custom paramter, with null signifying to clear the parameter.
void	setMaxResults(int maxResults) Sets the maximum number of results to return for the query.
void	setPublishedMax(DateTime publishedMax) Sets the maximum published timestamp used for the query.
void	setPublishedMin(DateTime publishedMin) Sets the minimum published timestamp used for the query.
void	setResultFormat(Query.ResultFormat resultFormat) Sets the expected query result format.
void	setStartIndex(int startIndex) Sets the start index for query results.
void	setStrict(boolean strict) Sets the strictness of parameter parsing.
final void	setStringCustomParameter(String name, String value) Sets a string custom parameter, with null signifying to clear the parameter.
void	setUpdatedMax(DateTime updatedMax) Sets the maximum updated timestamp used for the query.
void	setUpdatedMin(DateTime updatedMin) Sets the minimum updated timestamp used for the query.

From class java.lang.Object

Constants

public static final String EXT_PROP_QUERY

The name of the extended property query parameter that specifies that all events' extended properties must have matching values.

Constant Value: "extq"

public static final String MAXIMUM_START_TIME

The name of the custom query parameter that specifies that all events returned must be less than the specified time.

Constant Value: "start-max"

public static final String MINIMUM_START_TIME

The name of the custom query parameter that specifies that all events returned must be greater than or equal to the specified time.

Constant Value: "start-min"

Fields

private static final ExtendedPropertyMatch[] EMPTY_EXT_PROP_MATCH

An empty array of ExtendedPropertyMatch which will be returned from getExtendedPropertyQuery() should the current extended property query be empty.

Public Constructors

public CalendarQuery (URL feedUrl)

Constructs a new CalendarQuery object that targets a feed. The initial state of the query contains no parameters, meaning all entries in the feed would be returned if the query was executed immediately after construction.

Parameters

feedUrl	The URL of the feed against which queries will be executed.

Public Methods

public ExtendedPropertyMatch[] getExtendedPropertyQuery ()

Returns an array of extended property matches parsed from the current value of extq custom parameter.

Returns

the extended property query text. An empty array shall be returned when extended property matching is disabled for this CalendarQuery.

public DateTime getMaximumStartTime ()

Returns the maximum start time for events returned by the query. Only events that start before this time will be returned.

Returns

the maximum start time. A value of null indicates that maximum start-time based querying is disabled.

public DateTime getMinimumStartTime ()

Returns the minimum start time for events returned by the query. Only events that start on or after this time will be returned.

Returns

the minimum start time. A value of null indicates that minimum start-time based querying is disabled.

public void setExtendedPropertyQuery (ExtendedPropertyMatch... matches)

Sets up the extended property matching for events returned by the query by setting the extq custom parameter value.

Parameters

matches	Extended property matches. Only events that satisfy all of these will be returned. A value of `null` or an empty array of matches disables extended property matching for this CalendarQuery.

public void setMaximumStartTime (DateTime maxStart)

Sets the maximum start time for events returned by the query. Together with setMinimumStartTime(DateTime) creates a timespan such that only events that are within the timespan are returned.

Parameters

maxStart	The maximum start time. A value of `null` disables querying by maximum start time.

public void setMinimumStartTime (DateTime minStart)

Sets the minimum start time for events returned by the query. Together with setMaximumStartTime(DateTime) creates a timespan such that only events that are within the timespan are returned.

Parameters

minStart	The minimum start time. A value of `null` disables querying by minimum start time.

Classes

CalendarQuery

Class Overview

Summary

Constants

public static final String EXT_PROP_QUERY

public static final String MAXIMUM_START_TIME

public static final String MINIMUM_START_TIME

Fields

private static final ExtendedPropertyMatch[] EMPTY_EXT_PROP_MATCH

Public Constructors

public CalendarQuery (URL feedUrl)

Parameters

Public Methods

public ExtendedPropertyMatch[] getExtendedPropertyQuery ()

Returns

public DateTime getMaximumStartTime ()

Returns

public DateTime getMinimumStartTime ()

Returns

public void setExtendedPropertyQuery (ExtendedPropertyMatch... matches)

Parameters

public void setMaximumStartTime (DateTime maxStart)

Parameters

public void setMinimumStartTime (DateTime minStart)

Parameters