inc/FSclContactChangeInfo.h

   1 //
   2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   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  * @file                FSclContactChangeInfo.h
  18  * @brief               This is the header file for the %ContactChangeInfo class.
  19  *
  20  * This header file contains the declarations of the %ContactChangeInfo class.
  21  */
  22 #ifndef _FSCL_CONTACT_CHANGE_INFO_H_
  23 #define _FSCL_CONTACT_CHANGE_INFO_H_
  24
  25 #include <FBaseObject.h>
  26 #include <FSclTypes.h>
  27
  28 namespace Tizen { namespace Social
  29 {
  30
  31 /**
  32  * @class       ContactChangeInfo
  33  * @brief       This class provides a contact change information.
  34  *
  35  * @since       2.0
  36  *
  37  * @final       This class is not intended for extension.
  38  *
  39  * The %ContactChangeInfo class provides a contact change information.
  40  *
  41  */
  42 class _OSP_EXPORT_ ContactChangeInfo
  43         : public Tizen::Base::Object
  44 {
  45 public:
  46         /**
  47          * This is the default constructor for this class.
  48          *
  49          * @since       2.0
  50          */
  51         ContactChangeInfo(void);
  52
  53         /**
  54          * Copying of objects using this copy constructor is allowed.
  55          *
  56          * @since       2.0
  57          *
  58          * @param[in]   rhs             An instance of %ContactChangeInfo
  59          */
  60         ContactChangeInfo(const ContactChangeInfo& rhs);
  61
  62         /**
  63          * This destructor overrides Tizen::Base::Object::~Object().
  64          *
  65          * @since       2.0
  66          */
  67         virtual ~ContactChangeInfo(void);
  68
  69         /**
  70          * Checks whether the value of the specified instance is equal to the value of the current instance of Tizen::Base::Object.
  71          *
  72          * @since       2.0
  73          *
  74          * @return      @c true if the value of the specified instance of Tizen::Base::Object is equal to the value of the current instance of %Tizen::Base::Object, @n
  75          *                      else @c false
  76          * @param[in]   rhs     An instance of Tizen::Base::Object to compare
  77          */
  78         virtual bool Equals(const Tizen::Base::Object& rhs) const;
  79
  80         /**
  81          * Gets the hash value of the current instance.
  82          *
  83          * @since       2.0
  84          *
  85          * @return      The hash value of the current instance
  86          */
  87         virtual int GetHashCode(void) const;
  88
  89         /**
  90          * Gets the addressbook ID of the changed contact.
  91          *
  92          * @since       2.0
  93          *
  94          * @return      The addressbook ID
  95          */
  96         AddressbookId GetAddressbookId(void) const;
  97
  98         /**
  99          * Gets the ID of the changed contact.
 100          *
 101          * @since       2.0
 102          *
 103          * @return      The contact ID
 104          */
 105         RecordId GetContactId(void) const;
 106
 107         /**
 108          * Gets the version.
 109          *
 110          * @since       2.0
 111          *
 112          * @return      The version of the contact
 113          */
 114         int GetVersion(void) const;
 115
 116         /**
 117          * Gets the change type.
 118          *
 119          * @since       2.0
 120          *
 121          * @return      The change type
 122          */
 123         RecordChangeType GetChangeType(void) const;
 124
 125         /**
 126          * Checks whether the thumbnail has been changed or not.
 127          *
 128          * @since       2.1
 129          *
 130          * @return     @c true if the thumbnail has been changed, @n
 131          *              else @c false
 132          */
 133         bool IsThumbnailChanged(void) const;
 134
 135         /**
 136          * Copying of objects using this copy assignment operator is allowed.
 137          *
 138          * @since       2.0
 139          *
 140          * @param[in]   rhs             An instance of %ContactChangeInfo
 141          */
 142         ContactChangeInfo& operator =(const ContactChangeInfo& rhs);
 143
 144 private:
 145         friend class _ContactChangeInfoImpl;
 146         class _ContactChangeInfoImpl* __pContactChangeInfoImpl;
 147
 148 };      // ContactChangeInfo
 149
 150 }}      // Tizen::Social
 151
 152 #endif // _FSCL_CONTACT_CHANGE_INFO_H_