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