|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.gdata.client.Query
com.google.gdata.client.calendar.CalendarQuery
public class CalendarQuery
The CalendarQuery class extends the base GData Query class to define convenience APIs for Calendar custom query parameters.
Nested Class Summary | |
---|---|
static class |
CalendarQuery.ExtendedPropertyMatch
The ExtendedPropertyMatch class corresponds to a single extended property match. |
Nested classes/interfaces inherited from class com.google.gdata.client.Query |
---|
Query.CategoryFilter, Query.CustomParameter, Query.ResultFormat |
Field Summary | |
---|---|
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. |
Fields inherited from class com.google.gdata.client.Query |
---|
UNDEFINED |
Constructor Summary | |
---|---|
CalendarQuery(java.net.URL feedUrl)
Constructs a new CalendarQuery object that targets a feed. |
Method Summary | |
---|---|
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. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
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
Constructor Detail |
---|
public CalendarQuery(java.net.URL feedUrl)
feedUrl
- the URL of the feed against which queries will be
executed.Method Detail |
---|
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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |