/* * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved * * Licensed under the Apache License, Version 2.0 (the License); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an AS IS BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ using System; using System.Diagnostics.CodeAnalysis; using System.Runtime.InteropServices; namespace Tizen.Pims.Contacts { /// /// A record represents an actual record in the database. /// /// /// A record represents an actual record in the database, but you can also consider it a piece of information, such as an address, a phone number, or a group of contacts. /// A record can be a complex set of data, containing other data. For example, a contact record contains the address property, which is a reference to an address record. /// An address record belongs to a contact record, and its ContactId property is set to the identifier of the corresponding contact. In this case, the address is the child record of the contact and the contact is the parent record. /// /// 4 public class ContactsRecord : IDisposable { private string _uri = null; private uint _id; private Int64 _memoryPressure = ContactsViews.Record.AverageSize; internal IntPtr _recordHandle; internal ContactsRecord(IntPtr handle) { _recordHandle = handle; IntPtr viewUri; int error = Interop.Record.GetUriP(handle, out viewUri); if ((int)ContactsError.None != error) { Log.Error(Globals.LogTag, "ContactsRecord Failed with error " + error); throw ContactsErrorFactory.CheckAndCreateException(error); } GC.AddMemoryPressure(_memoryPressure); _uri = Marshal.PtrToStringAnsi(viewUri); } internal ContactsRecord(IntPtr handle, bool disposedValue) { _recordHandle = handle; _disposedValue = disposedValue; IntPtr viewUri; int error = Interop.Record.GetUriP(handle, out viewUri); if ((int)ContactsError.None != error) { Log.Error(Globals.LogTag, "ContactsRecord Failed with error " + error); throw ContactsErrorFactory.CheckAndCreateException(error); } if (!_disposedValue) GC.AddMemoryPressure(_memoryPressure); _uri = Marshal.PtrToStringAnsi(viewUri); } internal ContactsRecord(IntPtr handle, int id) { _recordHandle = handle; _id = (uint)id; IntPtr viewUri; int error = Interop.Record.GetUriP(handle, out viewUri); if ((int)ContactsError.None != error) { Log.Error(Globals.LogTag, "ContactsRecord Failed with error " + error); throw ContactsErrorFactory.CheckAndCreateException(error); } _uri = Marshal.PtrToStringAnsi(viewUri); GC.AddMemoryPressure(_memoryPressure); } /// /// Creates a record. /// /// The view URI. /// http://tizen.org/feature/contact /// Thrown when the feature is not supported. /// Thrown when one of the arguments provided to a method is not valid. /// Thrown when failed due to out of memory. /// 4 [SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")] public ContactsRecord(string viewUri) { int error = Interop.Record.Create(viewUri, out _recordHandle); if ((int)ContactsError.None != error) { Log.Error(Globals.LogTag, "ContactsRecord Failed with error " + error); throw ContactsErrorFactory.CheckAndCreateException(error); } _uri = viewUri; GC.AddMemoryPressure(_memoryPressure); } /// /// The destructor. /// /// 4 ~ContactsRecord() { Dispose(false); } /// /// The URI of the record. /// /// The URI of the record. /// 4 [SuppressMessage("Microsoft.Design", "CA1056:UriPropertiesShouldNotBeStrings")] public string Uri { get { return _uri; } } #region IDisposable Support internal bool _disposedValue = false; // To detect redundant calls /// /// Releases all the resources used by the ContactsRecord. /// /// Disposing by the user. /// 4 protected virtual void Dispose(bool disposing) { if (disposing) { //Called by User //Release your own managed resources here. //You should release all of your own disposable objects here } if (!_disposedValue) { int error = Interop.Record.Destroy(_recordHandle, true); if ((int)ContactsError.None != error) { Log.Error(Globals.LogTag, "Dispose Failed with error " + error); } _disposedValue = true; GC.RemoveMemoryPressure(_memoryPressure); } } /// /// Releases all the resources used by the ContactsRecord. /// It should be called after it has finished using the object. /// /// 4 public void Dispose() { Dispose(true); GC.SuppressFinalize(this); } #endregion /// /// Makes a clone of a record. /// /// A cloned record. /// http://tizen.org/feature/contact /// Thrown when the feature is not supported. /// Thrown when failed due to out of memory. /// 4 public ContactsRecord Clone() { IntPtr _clonedRecordHandle; int error = Interop.Record.Clone(_recordHandle, out _clonedRecordHandle); if ((int)ContactsError.None != error) { Log.Error(Globals.LogTag, "Clone Failed with error " + error); throw ContactsErrorFactory.CheckAndCreateException(error); } return new ContactsRecord(_clonedRecordHandle, (int)_id); } /// /// Gets a value of the property from a record. /// /// The property ID. /// /// The value of the property corresponding to a property ID. /// /// http://tizen.org/feature/contact /// Thrown when the feature is not supported. /// Thrown when one of the arguments provided to a method is not valid. /// 4 public T Get(uint propertyId) { object parsedValue = null; if (typeof(T) == typeof(string)) { string val; int error = Interop.Record.GetStr(_recordHandle, propertyId, out val); if ((int)ContactsError.None != error) { Log.Error(Globals.LogTag, "Get String Failed with error " + error); throw ContactsErrorFactory.CheckAndCreateException(error); } parsedValue = Convert.ChangeType(val, typeof(T)); } else if (typeof(T) == typeof(int)) { int val; int error = Interop.Record.GetInt(_recordHandle, propertyId, out val); if ((int)ContactsError.None != error) { Log.Error(Globals.LogTag, "Get Int Failed with error " + error); throw ContactsErrorFactory.CheckAndCreateException(error); } parsedValue = Convert.ChangeType(val, typeof(T)); } else if (typeof(T) == typeof(bool)) { bool val; int error = Interop.Record.GetBool(_recordHandle, propertyId, out val); if ((int)ContactsError.None != error) { Log.Error(Globals.LogTag, "Get Bool Failed with error " + error); throw ContactsErrorFactory.CheckAndCreateException(error); } parsedValue = Convert.ChangeType(val, typeof(T)); } else if (typeof(T) == typeof(long)) { long val; int error = Interop.Record.GetLli(_recordHandle, propertyId, out val); if ((int)ContactsError.None != error) { Log.Error(Globals.LogTag, "Get Long Failed with error " + error); throw ContactsErrorFactory.CheckAndCreateException(error); } parsedValue = Convert.ChangeType(val, typeof(T)); } else if (typeof(T) == typeof(double)) { double val; int error = Interop.Record.GetDouble(_recordHandle, propertyId, out val); if ((int)ContactsError.None != error) { Log.Error(Globals.LogTag, "Get Long Failed with error " + error); throw ContactsErrorFactory.CheckAndCreateException(error); } parsedValue = Convert.ChangeType(val, typeof(T)); } else { Log.Error(Globals.LogTag, "Not Supported Data Type"); throw ContactsErrorFactory.CheckAndCreateException((int)ContactsError.NotSupported); } return (T)parsedValue; } /// /// Sets a value of the property to a record. /// /// http://tizen.org/feature/contact /// Thrown when the feature is not supported. /// The property ID. /// The value to set. /// Thrown when one of the arguments provided to a method is not valid. /// 4 public void Set(uint propertyId, T value) { if (typeof(T) == typeof(string)) { string val = Convert.ToString(value); int error = Interop.Record.SetStr(_recordHandle, propertyId, val); if ((int)ContactsError.None != error) { Log.Error(Globals.LogTag, "Set String Failed with error " + error); throw ContactsErrorFactory.CheckAndCreateException(error); } } else if (typeof(T) == typeof(int)) { int val = Convert.ToInt32(value); int error = Interop.Record.SetInt(_recordHandle, propertyId, val); if ((int)ContactsError.None != error) { Log.Error(Globals.LogTag, "Set Int Failed with error " + error); throw ContactsErrorFactory.CheckAndCreateException(error); } } else if (typeof(T) == typeof(bool)) { bool val = Convert.ToBoolean(value); int error = Interop.Record.SetBool(_recordHandle, propertyId, val); if ((int)ContactsError.None != error) { Log.Error(Globals.LogTag, "Set Bool Failed with error " + error); throw ContactsErrorFactory.CheckAndCreateException(error); } } else if (typeof(T) == typeof(long)) { long val = Convert.ToInt64(value); int error = Interop.Record.SetLli(_recordHandle, propertyId, val); if ((int)ContactsError.None != error) { Log.Error(Globals.LogTag, "Set Long Failed with error " + error); throw ContactsErrorFactory.CheckAndCreateException(error); } } else if (typeof(T) == typeof(double)) { double val = Convert.ToDouble(value); int error = Interop.Record.SetDouble(_recordHandle, propertyId, val); if ((int)ContactsError.None != error) { Log.Error(Globals.LogTag, "Get Long Failed with error " + error); throw ContactsErrorFactory.CheckAndCreateException(error); } } else { Log.Error(Globals.LogTag, "Not Supported Data Type"); throw ContactsErrorFactory.CheckAndCreateException((int)ContactsError.NotSupported); } } /// /// Adds a child record to the parent record. /// /// The property ID. /// The child record to add to the parent record. /// http://tizen.org/feature/contact /// Thrown when the feature is not supported. /// Thrown when one of the arguments provided to a method is not valid. /// 4 public void AddChildRecord(uint propertyId, ContactsRecord childRecord) { int error = Interop.Record.AddChildRecord(_recordHandle, propertyId, childRecord._recordHandle); if ((int)ContactsError.None != error) { Log.Error(Globals.LogTag, "AddChildRecord Failed with error " + error); throw ContactsErrorFactory.CheckAndCreateException(error); } childRecord._disposedValue = true; } /// /// Removes a child record from the parent record. /// /// The property ID. /// The child record to remove from the parent record. /// http://tizen.org/feature/contact /// Thrown when feature is not supported. /// Thrown when one of the arguments provided to a method is not valid. /// 4 public void RemoveChildRecord(uint propertyId, ContactsRecord childRecord) { int error = Interop.Record.RemoveChildRecord(_recordHandle, propertyId, childRecord._recordHandle); if ((int)ContactsError.None != error) { Log.Error(Globals.LogTag, "RemoveChildRecord Failed with error " + error); throw ContactsErrorFactory.CheckAndCreateException(error); } childRecord._disposedValue = false; } /// /// Gets the number of child records of a parent record. /// /// The property ID. /// The number of child records corresponding to the property ID. /// http://tizen.org/feature/contact /// Thrown when the feature is not supported. /// Thrown when one of the arguments provided to a method is not valid. /// 4 public int GetChildRecordCount(uint propertyId) { int count = 0; int error = Interop.Record.GetChildRecordCount(_recordHandle, propertyId, out count); if ((int)ContactsError.None != error) { Log.Error(Globals.LogTag, "GetChildRecordCount Failed with error " + error); throw ContactsErrorFactory.CheckAndCreateException(error); } return count; } /// /// Gets a child record from the parent record. /// /// The property ID. /// The index of the child record. /// The record /// http://tizen.org/feature/contact /// Thrown when the feature is not supported. /// Thrown when one of the arguments provided to a method is not valid. /// 4 public ContactsRecord GetChildRecord(uint propertyId, int index) { IntPtr handle; int error = Interop.Record.GetChildRecordAtP(_recordHandle, propertyId, index, out handle); if ((int)ContactsError.None != error) { Log.Error(Globals.LogTag, "GetChildRecord Failed with error " + error); throw ContactsErrorFactory.CheckAndCreateException(error); } return new ContactsRecord(handle, true); } /// /// Clones a child record list corresponding to the property ID. /// /// The property ID. /// /// The record list. /// /// http://tizen.org/feature/contact /// Thrown when the feature is not supported. /// Thrown when one of the arguments provided to a method is not valid. /// 4 public ContactsList CloneChildRecordList(uint propertyId) { IntPtr listHandle; int error = Interop.Record.CloneChildRecordList(_recordHandle, propertyId, out listHandle); if ((int)ContactsError.None != error) { Log.Error(Globals.LogTag, "CloneChildRecordList Failed with error " + error); throw ContactsErrorFactory.CheckAndCreateException(error); } ContactsList list = new ContactsList(listHandle); return list; } } }