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             if (propertyIdArray == null)
 113             {
 114                 throw new ArgumentException("Invalid Parameters Provided");
 115             }
 116
 117             int error = Interop.Query.SetProjection(_queryHandle, propertyIdArray, propertyIdArray.Length);
 118             if (CalendarError.None != (CalendarError)error)
 119             {
 120                 Log.Error(Globals.LogTag, "SetProjection Failed with error " + error);
 121                 throw CalendarErrorFactory.GetException(error);
 122             }
 123         }
 124
 125         /// <summary>
 126         /// Sets the "distinct" option for projection.
 127         /// </summary>
 128         /// <since_tizen> 4 </since_tizen>
 129         /// <param name="set">If true it is set, otherwise if false it is unset</param>
 130         /// <feature>http://tizen.org/feature/calendar</feature>
 131         /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
 132         public void SetDistinct(bool set)
 133         {
 134             int error = Interop.Query.SetDistinct(_queryHandle, set);
 135             if (CalendarError.None != (CalendarError)error)
 136             {
 137                 Log.Error(Globals.LogTag, "SetDistinct Failed with error " + error);
 138                 throw CalendarErrorFactory.GetException(error);
 139             }
 140         }
 141
 142         /// <summary>
 143         /// Sets the filter for a query.
 144         /// </summary>
 145         /// <since_tizen> 4 </since_tizen>
 146         /// <param name="filter">The filter</param>
 147         /// <feature>http://tizen.org/feature/calendar</feature>
 148         /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
 149         /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
 150         public void SetFilter(CalendarFilter filter)
 151         {
 152             int error = Interop.Query.SetFilter(_queryHandle, filter._filterHandle);
 153             if (CalendarError.None != (CalendarError)error)
 154             {
 155                 Log.Error(Globals.LogTag, "SetFilter Failed with error " + error);
 156                 throw CalendarErrorFactory.GetException(error);
 157             }
 158         }
 159
 160         /// <summary>
 161         /// Sets the sort mode for a query.
 162         /// </summary>
 163         /// <since_tizen> 4 </since_tizen>
 164         /// <param name="propertyId">The property ID to sort</param>
 165         /// <param name="isAscending">If true it sorts in the ascending order, otherwise if false it sorts in the descending order</param>
 166         /// <feature>http://tizen.org/feature/calendar</feature>
 167         /// <exception cref="NotSupportedException">Thrown when feature is not supported</exception>
 168         /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid</exception>
 169         public void SetSort(uint propertyId, bool isAscending)
 170         {
 171             int error = Interop.Query.SetSort(_queryHandle, propertyId, isAscending);
 172             if (CalendarError.None != (CalendarError)error)
 173             {
 174                 Log.Error(Globals.LogTag, "SetSort Failed with error " + error);
 175                 throw CalendarErrorFactory.GetException(error);
 176             }
 177         }
 178     }
 179 }