src/platform/API/Contact/ContactPhoneNumber.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        ContactPhoneNumber.h
  19  * @author      Kisub Song (kisubs.song@samsung.com)
  20  * @version     0.1
  21  * @brief
  22  */
  23
  24 #ifndef _API_CONTACT_CONTACT_PHONE_NUMBER_H_
  25 #define _API_CONTACT_CONTACT_PHONE_NUMBER_H_
  26
  27 #include <algorithm>
  28 #include <string>
  29 #include <vector>
  30 #include <dpl/shared_ptr.h>
  31 #include "ContactTypes.h"
  32
  33 namespace TizenApis {
  34 namespace Api {
  35 namespace Contact {
  36
  37 class ContactPhoneNumber;
  38 typedef DPL::SharedPtr<ContactPhoneNumber> ContactPhoneNumberPtr;
  39
  40 typedef std::vector<ContactPhoneNumberPtr> ContactPhoneNumberArray;
  41 typedef DPL::SharedPtr<ContactPhoneNumberArray> ContactPhoneNumberArrayPtr;
  42
  43 typedef std::vector<ContactPhoneNumberType> ContactPhoneNumberTypeArray;
  44 typedef DPL::SharedPtr<ContactPhoneNumberTypeArray> ContactPhoneNumberTypeArrayPtr;
  45
  46 /* This object represents a phone number data of a contact */
  47 class ContactPhoneNumber
  48 {
  49 public:
  50         ContactPhoneNumber();
  51         ~ContactPhoneNumber();
  52
  53         std::string getNumber() const;
  54         void setNumber(const std::string &value);
  55         bool getNumberIsSet() const;
  56
  57         StringArrayPtr getTypes() const;
  58         void setTypes(const StringArrayPtr &value);
  59         void addType(const std::string value);
  60         bool isTypeOf(std::string value) const;
  61         int getTypesNum() const;
  62
  63         ContactPhoneNumberPtr clone() const;
  64
  65 private:
  66         std::string m_number;
  67         StringArrayPtr m_types;
  68
  69         bool m_numberIsSet;
  70 };
  71
  72 } // Contact
  73 } // Api
  74 } // TizenApis
  75
  76 #endif // _API_CONTACT_CONTACT_PHONE_NUMBER_H_