inc/FSclCalEventChangeInfo.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       FSclCalEventChangeInfo.h
  18   * @brief      This is the header file for the %CalEventChangeInfo class.
  19   *
  20   * This header file contains the declarations of the %CalEventChangeInfo class.
  21   */
  22 #ifndef _FSCL_CAL_EVENT_CHANGE_INFO_H_
  23 #define _FSCL_CAL_EVENT_CHANGE_INFO_H_
  24
  25 #include <FBaseObject.h>
  26 #include <FSclTypes.h>
  27
  28 namespace Tizen { namespace Social
  29 {
  30
  31 /**
  32  * @class       CalEventChangeInfo
  33  * @brief       This class represents the calendar event change information.
  34  *
  35  * @since       2.0
  36  *
  37  * @final       This class is not intended for extension.
  38  *
  39  *      The %CalEventChangeInfo class represents the change information of an event that is managed in the calendarbook.
  40  */
  41 class _OSP_EXPORT_ CalEventChangeInfo
  42         : public Tizen::Base::Object
  43 {
  44 public:
  45         /**
  46          * This is the default constructor for this class.
  47          *
  48          * @since       2.0
  49          */
  50         CalEventChangeInfo(void);
  51
  52         /**
  53          * Copying of objects using this copy constructor is allowed.
  54          *
  55          * @since       2.0
  56          *
  57          * @param[in]   rhs             An instance of %CalEventChangeInfo to copy
  58          */
  59         CalEventChangeInfo(const CalEventChangeInfo& rhs);
  60
  61         /**
  62          * This destructor overrides Tizen::Base::Object::~Object().
  63          *
  64          * @since       2.0
  65          */
  66         virtual ~CalEventChangeInfo(void);
  67
  68         /**
  69          * Compares the specified Tizen::Base::Object with the current %CalEventChangeInfo instance.
  70          *
  71          * @since       2.0
  72          *
  73          * @return              @c true if the specified object equals the current %CalEventChangeInfo instance, @n
  74          *                              else @c false
  75          * @param[in]   rhs     The object instance to compare with the current object
  76          * @see                 GetHashCode()
  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 change type.
  91          *
  92          * @since       2.0
  93          *
  94          * @return              The change type
  95          */
  96         RecordChangeType GetChangeType(void) const;
  97
  98         /**
  99          * Gets the changed event ID.
 100          *
 101          * @since       2.0
 102          *
 103          * @return              The changed event ID
 104          */
 105         RecordId GetEventId(void) const;
 106
 107         /**
 108          * Gets the calendar ID to which the changed event belongs.
 109          *
 110          * @since       2.0
 111          *
 112          * @return              The calendar ID to which the changed event belongs
 113          */
 114         RecordId GetCalendarId(void) const;
 115
 116         /**
 117          * Gets the version of the change.
 118          *
 119          * @since       2.0
 120          *
 121          * @return              The version of the change
 122          */
 123         int GetVersion(void) const;
 124
 125         /**
 126          * Copying of objects using this copy assignment operator is allowed.
 127          *
 128          * @since       2.0
 129          *
 130          * @param[in]   rhs             An instance of %CalEventChangeInfo to copy
 131          */
 132         CalEventChangeInfo& operator =(const CalEventChangeInfo& rhs);
 133
 134 private:
 135         friend class _CalEventChangeInfoImpl;
 136         class _CalEventChangeInfoImpl* __pCalEventChangeInfoImpl;
 137
 138 };      // CalEventChangeInfo
 139
 140 }}      // Tizen::Social
 141
 142 #endif // _FSCL_CAL_EVENT_CHANGE_INFO_H_
 143