src/modules/API/Filesystem/EventListNodes.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_FILESYSTEM_EVENTLISTNODES_H_
  17 #define WRTDEVICEAPIS_FILESYSTEM_EVENTLISTNODES_H_
  18
  19 #include <dpl/shared_ptr.h>
  20 #include <Commons/IEvent.h>
  21 #include "INodeTypes.h"
  22 #include "NodeFilter.h"
  23
  24 namespace WrtDeviceApis {
  25 namespace Filesystem {
  26 namespace Api {
  27
  28 class EventListNodes : public Commons::IEvent<EventListNodes>
  29 {
  30   public:
  31     /**
  32      * Creates new event object.
  33      * @param path Node to list children for.
  34      * @return New object.
  35      */
  36     explicit EventListNodes(const INodePtr& node);
  37
  38     /**
  39      * Gets parent node.
  40      * @return Parent node.
  41      */
  42     INodePtr getNode() const;
  43
  44     /**
  45      * Gets filter.
  46      * @return Filter.
  47      */
  48     NodeFilterPtr getFilter() const;
  49
  50     /**
  51      * Sets filter.
  52      * @param filter Filter to list only specific nodes.
  53      */
  54     void setFilter(const NodeFilterPtr& filter);
  55
  56     /**
  57      * Gets nodes.
  58      * @return Nodes list.
  59      */
  60     NodeList getResult() const;
  61
  62     /**
  63      * Sets nodes list.
  64      * @param list Nodes list.
  65      */
  66     void setResult(const NodeList& list);
  67
  68   private:
  69     NodeList m_list;      ///< List of child nodes.
  70     INodePtr m_node;      ///< Node to list children for.
  71     NodeFilterPtr m_filter; ///< Filter.
  72 };
  73
  74 typedef DPL::SharedPtr<EventListNodes> EventListNodesPtr;
  75
  76 } // API
  77 } // Filesystem
  78 } // WrtDeviceApis
  79
  80 #endif // WRTDEVICEAPIS_FILESYSTEM_EVENTLISTNODES_H_