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