src/platform/API/Contact/ContactAnniversary.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   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 /**
  18  * @file        ContactAnniversary.h
  19  * @author      Kisub Song (kisubs.song@samsung.com)
  20  * @version     0.1
  21  * @brief
  22  */
  23
  24 #ifndef _API_CONTACT_CONTACT_ANNIVERSARY_H_
  25 #define _API_CONTACT_CONTACT_ANNIVERSARY_H_
  26
  27 #include <ctime>
  28 #include <string>
  29 #include <vector>
  30 #include <dpl/shared_ptr.h>
  31
  32 namespace TizenApis {
  33 namespace Api {
  34 namespace Contact {
  35
  36 class ContactAnniversary;
  37 typedef DPL::SharedPtr<ContactAnniversary> ContactAnniversaryPtr;
  38
  39 typedef std::vector<ContactAnniversaryPtr> ContactAnniversaryArray;
  40 typedef DPL::SharedPtr<ContactAnniversaryArray> ContactAnniversaryArrayPtr;
  41
  42 /* This object represents an anniversary data of a contact */
  43 class ContactAnniversary
  44 {
  45 public:
  46         ContactAnniversary();
  47         ~ContactAnniversary();
  48
  49         std::tm getDate() const;
  50         void setDate(const std::tm &value);
  51         void unsetDate();
  52         bool getDateIsSet() const;
  53
  54         std::string getLabel() const;
  55         void setLabel(const std::string &value);
  56         void unsetLabel();
  57         bool getLabelIsSet() const;
  58
  59         void clear();
  60         ContactAnniversaryPtr clone() const;
  61
  62 private:
  63         std::tm         m_date;
  64         bool            m_dateIsSet;
  65
  66         std::string     m_label;
  67         bool            m_labelIsSet;
  68 };
  69
  70 } // Contact
  71 } // Api
  72 } // TizenApis
  73
  74 #endif // _API_CONTACT_CONTACT_ANNIVERSARY_H_