Class CalendarQuery

Definition

Namespace:

Tizen.Pims.Calendar

Assembly:

Tizen.Pims.Calendar.dll

A query is used to retrieve the data, which satisfies the given criteria.

public class CalendarQuery : IDisposable

Inheritance

object

CalendarQuery

Implements

System.IDisposable

Remarks

A query is used to retrieve the calendar data, which satisfies a given criteria, such as an integer property being greater than a given value, or a string property containing a given substring. A query needs a filter, which can set the conditions for the search.

Constructors

CalendarQuery(string)

Creates a query.

Declaration

public CalendarQuery(string viewUri)

Parameters

Type	Name	Description
string	viewUri	The view URI of a query.

Remarks

A query is used to retrieve the calendar data, which satisfies a given criteria, such as an integer property being greater than a given value, or a string property containing a given substring. A query needs a filter, which can set the conditions for the search.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the feature is not supported.
System.ArgumentException	Thrown when one of the arguments provided to a method is not valid.
System.OutOfMemoryException	Thrown when failed due to out of memory.

Methods

Dispose()

Releases all the resources used by the CalendarQuery. It should be called after it has finished using the object.

Declaration

public void Dispose()

Remarks

A query is used to retrieve the calendar data, which satisfies a given criteria, such as an integer property being greater than a given value, or a string property containing a given substring. A query needs a filter, which can set the conditions for the search.

Dispose(bool)

Disposes of the resources (other than memory) used by the CalendarQuery.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing	true to release both managed and unmanaged resources, false to release only unmanaged resources.

Remarks

A query is used to retrieve the calendar data, which satisfies a given criteria, such as an integer property being greater than a given value, or a string property containing a given substring. A query needs a filter, which can set the conditions for the search.

~CalendarQuery()

Destructor.

Declaration

protected ~CalendarQuery()

Remarks

A query is used to retrieve the calendar data, which satisfies a given criteria, such as an integer property being greater than a given value, or a string property containing a given substring. A query needs a filter, which can set the conditions for the search.

SetDistinct(bool)

Sets the "distinct" option for projection.

Declaration

public void SetDistinct(bool set)

Parameters

Type	Name	Description
bool	set	If true it is set, otherwise if false it is unset.

Remarks

A query is used to retrieve the calendar data, which satisfies a given criteria, such as an integer property being greater than a given value, or a string property containing a given substring. A query needs a filter, which can set the conditions for the search.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the feature is not supported.

SetFilter(CalendarFilter)

Sets the filter for a query.

Declaration

public void SetFilter(CalendarFilter filter)

Parameters

Type	Name	Description
CalendarFilter	filter	The filter.

Remarks

A query is used to retrieve the calendar data, which satisfies a given criteria, such as an integer property being greater than a given value, or a string property containing a given substring. A query needs a filter, which can set the conditions for the search.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the feature is not supported.
System.ArgumentException	Thrown when one of the arguments provided to a method is not valid.

SetProjection(uint[])

Adds the property IDs for projection.

Declaration

public void SetProjection(uint[] propertyIdArray)

Parameters

Type	Name	Description
uint[]	propertyIdArray	The property ID array.

Remarks

A query is used to retrieve the calendar data, which satisfies a given criteria, such as an integer property being greater than a given value, or a string property containing a given substring. A query needs a filter, which can set the conditions for the search.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the feature is not supported.
System.ArgumentException	Thrown when one of the arguments provided to a method is not valid.

SetSort(uint, bool)

Sets the sort mode for a query.

Declaration

public void SetSort(uint propertyId, bool isAscending)

Parameters

Type	Name	Description
uint	propertyId	The property ID to sort.
bool	isAscending	If true it sorts in the ascending order, otherwise if false it sorts in the descending order.

Remarks

A query is used to retrieve the calendar data, which satisfies a given criteria, such as an integer property being greater than a given value, or a string property containing a given substring. A query needs a filter, which can set the conditions for the search.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the feature is not supported.
System.ArgumentException	Thrown when one of the arguments provided to a method is not valid.

Implements

System.IDisposable