src/modules/API/Filesystem/EventFind.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 #ifndef WRTDEVICEAPIS_IEVENTFILESYSTEMFIND_H_
  17 #define WRTDEVICEAPIS_IEVENTFILESYSTEMFIND_H_
  18
  19 #include <list>
  20 #include <dpl/shared_ptr.h>
  21 #include <Commons/IEvent.h>
  22 #include "IPath.h"
  23 #include "INodeTypes.h"
  24 #include "Enums.h"
  25
  26 namespace WrtDeviceApis {
  27 namespace Filesystem {
  28 namespace Api {
  29
  30 class EventFind : public Commons::IEvent<EventFind>
  31 {
  32   public:
  33     /**
  34      * Creates new event object.
  35      * @param path Start path.
  36      * @return New object.
  37      */
  38     explicit EventFind(const IPathPtr& path);
  39
  40     /**
  41      * Gets start path.
  42      * @return Path to start searching from.
  43      */
  44     IPathPtr getPath() const;
  45
  46     /**
  47      * Gets found nodes.
  48      * @return Nodes.
  49      */
  50     NodeList getResult() const;
  51
  52     /**
  53      * Adds found node.
  54      * @param node Found node.
  55      */
  56     void addResult(const INodePtr& node);
  57
  58     /**
  59      * Sets found nodes.
  60      * @param nodes Nodes.
  61      */
  62     void setResult(const NodeList& nodes);
  63
  64     /**
  65      * Adds find filter.
  66      * @param name Filter name.
  67      * @param value Filter value.
  68      */
  69     void addFilter(FindFilter name,
  70             const std::string& value);
  71
  72     /**
  73      * Gets all filters.
  74      * @return Filters.
  75      */
  76     FiltersMap getFilters() const;
  77
  78   private:
  79     IPathPtr m_path;    ///< Start path.
  80     NodeList m_nodes;   ///< Resolved nodes.
  81     FiltersMap m_filters; ///< Search filters.
  82 };
  83
  84 typedef DPL::SharedPtr<EventFind> EventFindPtr;
  85
  86 } // API
  87 } // Filesystem
  88 } // WrtDeviceApis
  89
  90 #endif // WRTDEVICEAPIS_IEVENTFILESYSTEMFIND_H_