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