src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarQuery.cs

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 using System;
  18 using System.Diagnostics.CodeAnalysis;
  19
  20 namespace Tizen.Pims.Calendar
  21 {
  22     /// <summary>
  23     /// A query is used to retrieve data which satisfies given criteria.
  24     /// </summary>
  25     /// <since_tizen> 4 </since_tizen>
  26     /// <remarks>
  27     /// A query is used to retrieve calendar data which satisfies a given criteria,
  28     /// such as an integer property being greater than a given value,
  29     /// or a string property containing a given substring.
  30     /// A query needs a filter which can set the conditions for the search.
  31     /// </remarks>
  32     public class CalendarQuery:IDisposable
  33     {
  34         internal IntPtr _queryHandle;
  35
  36         /// <summary>
  37         /// Creates a query.
  38         /// </summary>
  39         /// <since_tizen> 4 </since_tizen>
  40         /// <feature>http://tizen.org/feature/calendar</feature>
  41         /// <param name="viewUri">The view URI of a query</param>
  42         /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
  43         /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
  44         /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
  45         [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
  46         public CalendarQuery(string viewUri)
  47         {
  48             int error = Interop.Query.Create(viewUri, out _queryHandle);
  49             if (CalendarError.None != (CalendarError)error)
  50             {
  51                 Log.Error(Globals.LogTag, "CalendarQuery Failed with error " + error);
  52                 throw CalendarErrorFactory.GetException(error);
  53             }
  54         }
  55
  56         internal CalendarQuery(IntPtr handle)
  57         {
  58             _queryHandle = handle;
  59         }
  60
  61         /// <summary>
  62         /// Destructor
  63         /// </summary>
  64         ~CalendarQuery()
  65         {
  66             Dispose(false);
  67         }
  68
  69 #region IDisposable Support
  70         private bool disposedValue = false;
  71
  72         /// <summary>
  73         /// Disposes of the resources (other than memory) used by the CalendarQuery.
  74         /// </summary>
  75         /// <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
  76         protected virtual void Dispose(bool disposing)
  77         {
  78             if (!disposedValue)
  79             {
  80                 Log.Debug(Globals.LogTag, "Dispose :" + disposing);
  81
  82                 int error = Interop.Query.Destroy(_queryHandle);
  83                 if (CalendarError.None != (CalendarError)error)
  84                 {
  85                     Log.Error(Globals.LogTag, "CalendarQueryDestroy Failed with error " + error);
  86                 }
  87                 disposedValue = true;
  88             }
  89         }
  90
  91         /// <summary>
  92         /// Releases all resources used by the CalendarQuery.
  93         /// It should be called after having finished using of the object.
  94         /// </summary>
  95         public void Dispose()
  96         {
  97             Dispose(true);
  98             GC.SuppressFinalize(this);
  99         }
 100 #endregion
 101
 102         /// <summary>
 103         /// Adds property IDs for projection.
 104         /// </summary>
 105         /// <since_tizen> 4 </since_tizen>
 106         /// <param name="propertyIdArray">The property ID array </param>
 107         /// <feature>http://tizen.org/feature/calendar</feature>
 108         /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
 109         /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
 110         public void SetProjection(uint[] propertyIdArray)
 111         {
 112             int error = Interop.Query.SetProjection(_queryHandle, propertyIdArray, propertyIdArray.Length);
 113             if (CalendarError.None != (CalendarError)error)
 114             {
 115                 Log.Error(Globals.LogTag, "SetProjection Failed with error " + error);
 116                 throw CalendarErrorFactory.GetException(error);
 117             }
 118         }
 119
 120         /// <summary>
 121         /// Sets the "distinct" option for projection.
 122         /// </summary>
 123         /// <since_tizen> 4 </since_tizen>
 124         /// <param name="set">If true it is set, otherwise if false it is unset</param>
 125         /// <feature>http://tizen.org/feature/calendar</feature>
 126         /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
 127         /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
 128         public void SetDistinct(bool set)
 129         {
 130             int error = Interop.Query.SetDistinct(_queryHandle, set);
 131             if (CalendarError.None != (CalendarError)error)
 132             {
 133                 Log.Error(Globals.LogTag, "SetDistinct Failed with error " + error);
 134                 throw CalendarErrorFactory.GetException(error);
 135             }
 136         }
 137
 138         /// <summary>
 139         /// Sets the filter for a query.
 140         /// </summary>
 141         /// <since_tizen> 4 </since_tizen>
 142         /// <param name="filter">The filter</param>
 143         /// <feature>http://tizen.org/feature/calendar</feature>
 144         /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
 145         /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
 146         public void SetFilter(CalendarFilter filter)
 147         {
 148             int error = Interop.Query.SetFilter(_queryHandle, filter._filterHandle);
 149             if (CalendarError.None != (CalendarError)error)
 150             {
 151                 Log.Error(Globals.LogTag, "SetFilter Failed with error " + error);
 152                 throw CalendarErrorFactory.GetException(error);
 153             }
 154         }
 155
 156         /// <summary>
 157         /// Sets the sort mode for a query.
 158         /// </summary>
 159         /// <since_tizen> 4 </since_tizen>
 160         /// <param name="propertyId">The property ID to sort</param>
 161         /// <param name="isAscending">If true it sorts in the ascending order, otherwise if false it sorts in the descending order</param>
 162         /// <feature>http://tizen.org/feature/calendar</feature>
 163         /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
 164         /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
 165         public void SetSort(uint propertyId, bool isAscending)
 166         {
 167             int error = Interop.Query.SetSort(_queryHandle, propertyId, isAscending);
 168             if (CalendarError.None != (CalendarError)error)
 169             {
 170                 Log.Error(Globals.LogTag, "SetSort Failed with error " + error);
 171                 throw CalendarErrorFactory.GetException(error);
 172             }
 173         }
 174     }
 175 }