src/modules/API/Filesystem/EventCopy.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_EVENTCOPY_H_
  17 #define WRTDEVICEAPIS_FILESYSTEM_EVENTCOPY_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 EventCopy : public Commons::IEvent<EventCopy>
  29 {
  30   public:
  31     /**
  32      * Creates new event object.
  33      * @param src Path to source node.
  34      * @param dest Path to destination node.
  35      * @return New object.
  36      */
  37     EventCopy(const IPathPtr& src,
  38             const IPathPtr& dest);
  39
  40     /**
  41      * Gets destination path.
  42      * @return Destination path.
  43      */
  44     IPathPtr getDestination() const;
  45
  46     /**
  47      * Gets source path.
  48      * @return Source path.
  49      */
  50     IPathPtr getSource() const;
  51
  52     /**
  53      * Gets result node.
  54      * @return Result node.
  55      */
  56     INodePtr getResult() const;
  57
  58     /**
  59      * Sets result node.
  60      * @param node Result node.
  61      */
  62     void setResult(const INodePtr& node);
  63
  64     /**
  65      * Gets options.
  66      * @return Options.
  67      */
  68     int getOptions() const;
  69
  70     /**
  71      * Sets options.
  72      * @param options Options.
  73      */
  74     void setOptions(int options);
  75
  76   private:
  77     IPathPtr m_src;   ///< Source path.
  78     IPathPtr m_dest;  ///< Destination path.
  79     INodePtr m_result; ///< Result node.
  80     int m_options;    ///< Options for copy action @see WrtDeviceApis::Api::Filesystem::Options.
  81 };
  82
  83 typedef DPL::SharedPtr<EventCopy> EventCopyPtr;
  84
  85 } // API
  86 } // Filesystem
  87 } // WrtDeviceApis
  88
  89 #endif // WRTDEVICEAPIS_FILESYSTEM_EVENTCOPY_H_