com.telerik.widget.calendar.events.read

Class EventQueryToken

java.lang.Object

com.telerik.widget.calendar.events.read.EventQueryToken

public class EventQueryToken
extends Object

This class holds the query tokens to be used in building the query for reading the events from the calendars on the current phone device.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CALENDAR_ID_SELECTION The selection for filtering by calendar id.
static String	CALENDAR_OWNER_SELECTION The selection for filtering by owner account.
String	selection The selection of the query.
String[]	selectionArgs The arguments of the query.

Constructor Summary

Constructors

Constructor and Description
EventQueryToken(String selection, String[] selectionArgs) Creates a new instance of the EventQueryToken class.

Method Summary

Modifier and Type	Method and Description
static EventQueryToken	getCalendarById(String id) Gets the query tokens for accessing a calendar by using its id.
static EventQueryToken	getCalendarsById(String[] calendarIDs) Gets the query tokens for accessing calendars by providing their IDs.
static EventQueryToken	getCalendarsByOwner(String owner) Gets the query token for accessing a calendar belonging to a specific user.
static EventQueryToken	getCalendarsByOwners(String[] owners) Gets the query token for accessing a calendar belonging to a specific collection of users.
static EventQueryToken	getDefaultCalendar() Gets the query tokens for accessing the default calendar of the phone device.
long	getMaxDate() Gets the max date for the query.
long	getMinDate() Gets the min date for the query.
void	setMaxDate(long maxDate) Sets the max date for the query.
void	setMinDate(long minDate) Sets the min date for the query.
void	setRange(long minDate, long maxDate) Sets the min and max dates for the query.

Methods inherited from class java.lang.Object

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

Field Detail

CALENDAR_ID_SELECTION

public static final String CALENDAR_ID_SELECTION

The selection for filtering by calendar id.

See Also:

Constant Field Values

CALENDAR_OWNER_SELECTION

public static final String CALENDAR_OWNER_SELECTION

The selection for filtering by owner account.

See Also:

Constant Field Values

selection

public String selection

The selection of the query. Not to be used directly. Use buildSelection() instead.

selectionArgs

public String[] selectionArgs

The arguments of the query.

Constructor Detail

EventQueryToken

public EventQueryToken(String selection,
                       String[] selectionArgs)

Creates a new instance of the EventQueryToken class.

Parameters:

selection - the base selection to be used.

selectionArgs - the selection arguments to be used.

Method Detail

getDefaultCalendar

public static EventQueryToken getDefaultCalendar()

Gets the query tokens for accessing the default calendar of the phone device.

Returns:

the default query tokens.

getCalendarById

public static EventQueryToken getCalendarById(String id)

Gets the query tokens for accessing a calendar by using its id.

Parameters:

id - the id of the calendar.

Returns:

the query tokens for accessing the calendar with the specified id.

getCalendarsById

public static EventQueryToken getCalendarsById(String[] calendarIDs)

Gets the query tokens for accessing calendars by providing their IDs.

Parameters:

calendarIDs - a collection of the IDs of the calendars.

Returns:

the query token for accessing the calendars with the provided IDs.

getCalendarsByOwner

public static EventQueryToken getCalendarsByOwner(String owner)

Gets the query token for accessing a calendar belonging to a specific user.

Parameters:

owner - the name of the user owning the calendar.

Returns:

the query token for accessing the calendar belonging to the specified user.

getCalendarsByOwners

public static EventQueryToken getCalendarsByOwners(String[] owners)

Gets the query token for accessing a calendar belonging to a specific collection of users.

Parameters:

owners - the names of the users owning the calendars.

Returns:

the query token for accessing the calendars belonging to the specified users.

getMinDate

public long getMinDate()

Gets the min date for the query. The events before this date will not be included in the query. Default value is 0, which means all events before the max date, if such is present will be included.

Returns:

the current min date.

setMinDate

public void setMinDate(long minDate)

Sets the min date for the query. The events before this date will not be included in the query. Default value is 0, which means all events before the max date, if such is present will be included.

Parameters:

minDate - the new min date.

getMaxDate

public long getMaxDate()

Gets the max date for the query. The events after this date will not be included in the query. Default value is 0, which means all events after the min date, if such is present will be included.

Returns:

the current max date.

setMaxDate

public void setMaxDate(long maxDate)

Sets the max date for the query. The events after this date will not be included in the query. Default value is 0, which means all events after the min date, if such is present will be included.

Parameters:

maxDate - the new max date.

setRange

public void setRange(long minDate,
                     long maxDate)

Sets the min and max dates for the query. The events before the min date and the events after the max date will not be included in the query. Default value is 0, which means all events after the min date and before the max date will be included.

Parameters:

minDate - the new minDate.

maxDate - the new max date.