inc/FSclContactEvent.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         FSclContactEvent.h
  18 * @brief        This is the header file for the %ContactEvent class.
  19 *
  20 * This header file contains the declarations of the %ContactEvent class.
  21 */
  22 #ifndef _FSCL_CONTACT_EVENT_H_
  23 #define _FSCL_CONTACT_EVENT_H_
  24
  25 #include <FBaseResult.h>
  26 #include <FBaseObject.h>
  27 #include <FBaseString.h>
  28 #include <FBaseDateTime.h>
  29 #include <FSclTypes.h>
  30
  31 namespace Tizen { namespace Social
  32 {
  33
  34 /**
  35 * @class        ContactEvent
  36 * @brief        This class represents an event.
  37 *
  38 * @since        2.0
  39 *
  40 * @final        This class is not intended for extension.
  41 *
  42 * The %ContactEvent class represents an event. An event consists of the event date, type, and label.
  43 *
  44 */
  45 class _OSP_EXPORT_ ContactEvent
  46         : public Tizen::Base::Object
  47 {
  48 public:
  49         /**
  50          * This is the default constructor for this class.
  51          *
  52          * @since       2.0
  53          */
  54         ContactEvent(void);
  55
  56         /**
  57          * Copying of objects using this copy constructor is allowed.
  58          *
  59          * @since       2.0
  60          *
  61          * @param[in]   rhs     An instance of %ContactEvent
  62          */
  63         ContactEvent(const ContactEvent& rhs);
  64
  65         /**
  66          * This destructor overrides Tizen::Base::Object::~Object().
  67          *
  68          * @since       2.0
  69          */
  70         virtual ~ContactEvent(void);
  71
  72         /**
  73          * Checks whether the value of the specified instance is equal to the value of the current instance of Tizen::Base::Object.
  74          *
  75          * @since       2.0
  76          *
  77          * @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
  78          *                      else @c false
  79          * @param[in]   rhs             An instance of Tizen::Base::Object to compare
  80          */
  81         virtual bool Equals(const Tizen::Base::Object& rhs) const;
  82
  83         /**
  84          * Gets the hash value of the current instance of Tizen::Base::Object.
  85          *
  86          * @since       2.0
  87          *
  88          * @return      An integer value indicating the hash value of the current instance of Tizen::Base::Object
  89          */
  90         virtual int GetHashCode(void) const;
  91
  92         /**
  93          * Gets the event type.
  94          *
  95          * @since       2.0
  96          *
  97          * @return      The type of the event
  98          */
  99         ContactEventType GetType(void) const;
 100
 101         /**
 102          * Gets the event date.
 103          *
 104          * @since       2.0
 105          *
 106          * @return      The event date
 107          */
 108         Tizen::Base::DateTime GetDate(void) const;
 109
 110         /**
 111          * Gets the label of an event.
 112          *
 113          * @since       2.0
 114          *
 115          * @return      The event label
 116          * @see SetLabel()
 117          */
 118         Tizen::Base::String GetLabel(void) const;
 119
 120         /**
 121          * Sets the event type.
 122          *
 123          * @since       2.0
 124          *
 125          * @param[in]   type    The type of the event
 126          */
 127         void SetType(ContactEventType type);
 128
 129         /**
 130          * Sets the label of an event.
 131          *
 132          * @since       2.0
 133          *
 134          * @param[in]   label   The event label
 135          * @see GetLabel()
 136          */
 137         void SetLabel(const Tizen::Base::String& label);
 138
 139         /**
 140          * Sets the event date. @n
 141          * The time portion of Tizen::Base::DateTime is ignored. The default time is 00:00:00.
 142          *
 143          * @since       2.0
 144          *
 145          * @param[in]   date    The event date
 146          */
 147         void SetDate(const Tizen::Base::DateTime& date);
 148
 149         /**
 150          * Copying of objects using this copy assignment operator is allowed.
 151          *
 152          * @since       2.0
 153          *
 154          * @param[in]   rhs     An instance of %ContactEvent
 155          */
 156         ContactEvent& operator =(const ContactEvent& rhs);
 157
 158         /**
 159          * Checks whether the data in the specified instance of %ContactEvent is equal to the data in the current instance.
 160          *
 161          * @since       2.0
 162          *
 163          * @return              @c true if the data in the specified instance equals the data in the current instance, @n
 164          *                              else @c false
 165          * @param[in]   rhs             An instance of %ContactEvent
 166          */
 167         bool operator ==(const ContactEvent& rhs) const;
 168
 169         /**
 170          * Checks whether the data in the specified instance of %ContactEvent is not equal to the data in the current instance.
 171          *
 172          * @since       2.0
 173          *
 174          * @return              @c true if the data in the specified instance is not equal to the data in the current instance, @n
 175          *                              else @c false
 176          * @param[in]   rhs             An instance of %ContactEvent
 177          */
 178         bool operator !=(const ContactEvent& rhs) const;
 179
 180 private:
 181         friend class _ContactEventImpl;
 182         class _ContactEventImpl* __pContactEventImpl;
 183
 184 }; // ContactEvent
 185
 186 }} // Tizen::Social
 187
 188 #endif // _FSCL_CONTACT_EVENT_H_