src/modules/API/Filesystem/EventResolve.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_EVENTRESOLVE_H_
  17 #define WRTDEVICEAPIS_FILESYSTEM_EVENTRESOLVE_H_
  18
  19 #include <dpl/shared_ptr.h>
  20 #include <Commons/IEvent.h>
  21 #include "IPath.h"
  22 #include "INode.h"
  23
  24 namespace WrtDeviceApis {
  25 namespace Filesystem {
  26 namespace Api {
  27
  28 class EventResolve : public Commons::IEvent<EventResolve>
  29 {
  30   public:
  31     /**
  32      * Creates new event object.
  33      * @param path Path to the node to resolve.
  34      * @return New object.
  35      */
  36     explicit EventResolve(const IPathPtr& path);
  37
  38     /**
  39      * Gets path of the node to resolve.
  40      * @return Path to resolve.
  41      */
  42     IPathPtr getPath() const;
  43
  44     /**
  45      * Gets resolved node.
  46      * NULL if none found. Check exception code.
  47      * @return Resolved node or NULL.
  48      */
  49     INodePtr getResult() const;
  50
  51     /**
  52      * Sets resolved node.
  53      * @param node Resolved node.
  54      */
  55     void setResult(const INodePtr& node);
  56
  57   private:
  58     IPathPtr m_path; ///< Path to the requested node.
  59     INodePtr m_node; ///< Resolved node.
  60 };
  61
  62 typedef DPL::SharedPtr<EventResolve> EventResolvePtr;
  63
  64 } // API
  65 } // Filesystem
  66 } // WrtDeviceApis
  67
  68 #endif // WRTDEVICEAPIS_FILESYSTEM_EVENTRESOLVE_H_