modules_mobile/widget_interface_dao/include/wrt-commons/widget-interface-dao/widget_interface_dao.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  * @author      Lukasz Marek (l.marek@samsung.com)
  18  * @version     0.1
  19  * @brief
  20  */
  21
  22 #ifndef _WIDGET_INTERFACE_DAO_H_
  23 #define _WIDGET_INTERFACE_DAO_H_
  24
  25 #include <string>
  26 #include <dpl/db/thread_database_support.h>
  27 #include <dpl/db/orm_interface.h>
  28
  29 namespace WidgetInterfaceDB {
  30 class WidgetInterfaceDAO
  31 {
  32   public:
  33
  34     /**
  35      * WidgetInterfaceDAO Exception classes
  36      */
  37     class Exception
  38     {
  39       public:
  40         DECLARE_EXCEPTION_TYPE(DPL::Exception, Base)
  41         DECLARE_EXCEPTION_TYPE(Base, DatabaseError)
  42         DECLARE_EXCEPTION_TYPE(Base, LocalStorageValueNoModifableException)
  43         DECLARE_EXCEPTION_TYPE(Base, InvalidArgumentException)
  44     };
  45     WidgetInterfaceDAO(int widgetHandle);
  46     virtual ~WidgetInterfaceDAO();
  47
  48     static std::string databaseFileName(int widgetHandle);
  49     void setItem(const std::string& key,
  50                  const std::string& value,
  51                  bool readOnly,
  52                  bool fromConfigXml);
  53     void setItem(const std::string& key,
  54                  const std::string& value,
  55                  bool readOnly);
  56     void removeItem(const std::string& key);
  57     DPL::Optional<std::string> getValue(const std::string& key) const;
  58     void clear(bool removeReadOnly);
  59     size_t getStorageSize() const;
  60     std::string getKeyByIndex(size_t index) const;
  61
  62   protected:
  63     int m_widgetHandle;
  64     mutable DPL::DB::ThreadDatabaseSupport m_databaseInterface;
  65
  66   private:
  67     void checkDatabase();
  68     void copyPropertiesFromWrtDatabase();
  69 };
  70 typedef std::unique_ptr<WidgetInterfaceDAO> WidgetInterfaceDAOPtr;
  71 }
  72 #endif //_WIDGET_INTERFACE_DAO_H_