public class CalendarQuery extends Query
Modifier and Type | Class and Description |
---|---|
static class |
CalendarQuery.ExtendedPropertyMatch
The ExtendedPropertyMatch class corresponds to a single
extended property match.
|
Query.CategoryFilter, Query.CustomParameter, Query.ResultFormat
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
EXT_PROP_QUERY
The name of the extended property query parameter that specifies that all
events' extended properties must have matching values.
|
static java.lang.String |
MAXIMUM_START_TIME
The name of the custom query parameter that specifies that all
events returned must be less than the specified time.
|
static java.lang.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.
|
Constructor and Description |
---|
CalendarQuery(java.net.URL feedUrl)
Constructs a new CalendarQuery object that targets a feed.
|
Modifier and Type | Method and Description |
---|---|
CalendarQuery.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(CalendarQuery.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.
|
addCategoryFilter, addCustomParameter, appendQueryParameter, getAuthor, getCategoryFilters, getCustomParameters, getCustomParameters, getFeedUrl, getFields, getFullTextQuery, getIntegerCustomParameter, getMaxResults, getPublishedMax, getPublishedMin, getQueryUri, getResultFormat, getStartIndex, getStringCustomParameter, getUpdatedMax, getUpdatedMin, getUrl, isStrict, isValidState, setAuthor, setFields, setFullTextQuery, setIntegerCustomParameter, setMaxResults, setPublishedMax, setPublishedMin, setResultFormat, setStartIndex, setStrict, setStringCustomParameter, setUpdatedMax, setUpdatedMin
public static final java.lang.String MINIMUM_START_TIME
public static final java.lang.String MAXIMUM_START_TIME
public static final java.lang.String EXT_PROP_QUERY
public CalendarQuery(java.net.URL feedUrl)
feedUrl
- the URL of the feed against which queries will be
executed.public void setMinimumStartTime(DateTime minStart)
setMaximumStartTime(com.google.gdata.data.DateTime)
creates a timespan such that only events
that are within the timespan are returned.minStart
- the minimum start time. A value of null
disables querying by minimum start time.public DateTime getMinimumStartTime()
null
indicates
that minimum start-time based querying is disabled.public void setMaximumStartTime(DateTime maxStart)
setMinimumStartTime(com.google.gdata.data.DateTime)
creates a timespan such that only events
that are within the timespan are returned.maxStart
- the maximum start time. A value of null
disables querying by maximum start time.public DateTime getMaximumStartTime()
null
indicates
that maximum start-time based querying is disabled.public void setExtendedPropertyQuery(CalendarQuery.ExtendedPropertyMatch... matches)
extq
custom parameter value.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 CalendarQuery.ExtendedPropertyMatch[] getExtendedPropertyQuery()
extq
custom parameter.