inc/IntBookmarkData.h

   1 //
   2
   3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Flora License, Version 1.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://floralicense.org/license/
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an AS IS BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17
  18 /**
  19  * @file        IntBookmark.h
  20  * @brief               This header file contains the declarations of the BookmarkData class.
  21  *
  22  *
  23  */
  24 #ifndef _INT_BOOKMARK_DATA_H_
  25 #define _INT_BOOKMARK_DATA_H_
  26
  27
  28 #include <FBase.h>
  29
  30 /**
  31  * @enum BookmarkType
  32  *
  33  * BookmarkType enum is used to define type of bookmark
  34  *
  35  */
  36 typedef enum BookmarkType
  37 {
  38         BOOKMARK_TYPE_URL = 0,
  39         BOOKMARK_TYPE_FOLDER
  40 }type;
  41
  42 /**
  43  * @class Bookmark
  44  * @brief This is a model class which contains all the properties of Bookmark class
  45  *                  and the methods to get and set the values for those properties
  46  */
  47 class BookmarkData
  48         : public Tizen::Base::Object
  49 {
  50 public:
  51         /**
  52          * @brief Default constructor
  53          */
  54         BookmarkData(void);
  55
  56         /**
  57          *@brief Initialises the instance the class Bookmark with the specified parameter
  58          */
  59         BookmarkData(const BookmarkData& bm);
  60
  61         /**
  62          *@brief Default destructor
  63          */
  64         ~BookmarkData(void);
  65
  66         /**
  67          *@brief "=" operator overloading
  68          */
  69         BookmarkData& operator =(const BookmarkData& pBookmark);
  70
  71         /**
  72          * This function gets the BookmarkId
  73          *
  74          * @return      A String
  75          * @param               No parameter
  76          */
  77         Tizen::Base::String GetBookmarkId(void);
  78
  79         /**
  80          * This function gets the BookmarkTitle
  81          *
  82          * @return      A String
  83          * @param               No parameter
  84          */
  85         Tizen::Base::String GetBookmarkTitle(void);
  86
  87         /**
  88          * This function gets the BookmarkType whether FOLDER or URL
  89          *
  90          * @return      enum type
  91          * @param               No parameter
  92          */
  93         type GetBookmarkType(void);
  94
  95         /**
  96          * This function gets the created time for the bookmark
  97          *
  98          * @return      DateTime
  99          * @param               No parameter
 100          */
 101         Tizen::Base::DateTime GetCreatedTime(void);
 102
 103         /**
 104          * This function gets the FaviconId
 105          *
 106          * @return      A String
 107          * @param               No parameter
 108          */
 109         Tizen::Base::String GetFaviconId(void);
 110
 111         /**
 112          * This function gets the path of the favicon of URL
 113          *
 114          * @return      A String
 115          * @param               No parameter
 116          */
 117         Tizen::Base::String GetIconPath(void);
 118
 119         /**
 120          * This function gets the modified time for the bookmark
 121          *
 122          * @return      DateTime
 123          * @param               No parameter
 124          */
 125         Tizen::Base::DateTime GetModifiedTime(void);
 126
 127         /**
 128          * This function gets the parentId
 129          *
 130          * @return      A String
 131          * @param               No parameter
 132          */
 133         Tizen::Base::String GetParentId(void);
 134
 135         /**
 136          * This function gets the URL
 137          *
 138          * @return      A String
 139          * @param               No parameter
 140          */
 141         Tizen::Base::String GetUrl(void);
 142
 143
 144         /**
 145          * This function sets the BookmarkId for the bookmark object
 146          *
 147          * @return      No return type
 148          * @param               strBookmarkId                           The ID for the bookmark object
 149          */
 150         void SetBookmarkId(const Tizen::Base::String& strBookmarkId);
 151
 152         /**
 153          * This function sets the BookmarkTitle for the bookmark object
 154          *
 155          * @return      No return type
 156          * @param               strTitle                                        The Title for the bookmark object
 157          */
 158         void SetBookmarkTitle(Tizen::Base::String& strTitle);
 159
 160         /**
 161          * This function sets the createdTime for the bookmark object
 162          *
 163          * @return      No return type
 164          * @param               strCreatedTime                          The createdTime for the bookmark
 165          */
 166         void SetCreatedTime(const Tizen::Base::DateTime& strCreatedTime);
 167
 168         /**
 169          * This function sets the faviconid
 170          *
 171          * @return      No return type
 172          * @param               strFaviconId                            The ID for the favicon object
 173          */
 174         void SetFaviconId(const Tizen::Base::String& strFaviconId);
 175
 176         /**
 177          * This function sets the path for the favicon of the bookmark object
 178          *
 179          * @return      No return type
 180          * @param               strFilePath                                     The path for the favicon icon of bookmark
 181          */
 182         void SetIconPath(const Tizen::Base::String& strFilePath);
 183
 184         /**
 185          * This function sets the ModifiedTime for the bookmark object
 186          *
 187          * @return      No return type
 188          * @param               strModifiedTime                         The ModifiedTime for the bookmark
 189          */
 190         void SetModifiedTime(const Tizen::Base::DateTime& strModifiedTime);
 191
 192         /**
 193          * This function sets the ParentId for the bookmark object
 194          *
 195          * @return      No return type
 196          * @param               strParentID                                     The parentId for the bookmark object
 197          */
 198         void SetParentId(const Tizen::Base::String& strParentID);
 199
 200         /**
 201          * This function sets the URL for the bookmark object
 202          *
 203          * @return      No return type
 204          * @param               strTitle                                        The URL for the bookmark object
 205          */
 206         void SetUrl(const Tizen::Base::String& strUrl);
 207
 208 private:
 209         Tizen::Base::String     __bookmarkId;
 210         type    __bookmarkType;
 211         Tizen::Base::String     __bookmarkTitle;
 212         Tizen::Base::String     __bookmarkUrl;
 213         Tizen::Base::DateTime   __createdTime;
 214         Tizen::Base::String     __faviconId;
 215         Tizen::Base::String     __iconPath;
 216         Tizen::Base::DateTime __modifiedTime;
 217         Tizen::Base::String     __parentId;
 218 };
 219
 220 #endif //_INT_BOOKMARK_DATA_H_