inc/FCntIContentScanListener.h

   1 //
   2 // Copyright (c) 2013 Samsung Electronics Co., Ltd.
   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
  17 /**
  18  * @file                FCntIContentScanListener.h
  19  * @brief               This is the header file for the %IContentScanListener interface.
  20  *
  21  * This header file contains the declarations of the %IContentScanListener interface.
  22  */
  23
  24 #ifndef _FCNT_ICONTENT_SCAN_LISTENER_H_
  25 #define _FCNT_ICONTENT_SCAN_LISTENER_H_
  26
  27 #include <FBaseRtIEventListener.h>
  28
  29 namespace Tizen { namespace Content
  30 {
  31 /**
  32  * @interface   IContentScanListener
  33  * @brief               This interface is used for receiving the scan operation event.
  34  *
  35  * @since 2.1
  36  *
  37  * The %IContentScanListener interface is used for receiving the scan operation event.
  38  */
  39 class _OSP_EXPORT_ IContentScanListener
  40         : virtual public Tizen::Base::Runtime::IEventListener
  41 {
  42 public:
  43         /**
  44          * This polymorphic destructor should be overridden if required. @n
  45          * This way, the destructors of the derived classes are called when the destructor of this interface is called.
  46          *
  47          * @since       2.1
  48          */
  49         virtual ~IContentScanListener(void) {}
  50
  51         /**
  52          * Called when the scan operation is completed.
  53          *
  54          * @since                       2.1
  55          *
  56          * @param[in]           reqId                           The request ID returned by ContentManager::ScanDirectory()
  57          * @param[in]           scanPath                        The scan path
  58          * @param[in]           r                                       The error of the scan operation @n
  59          *                                                                              The following exceptions are given through this parameter.
  60          * @exception           E_SUCCESS                       The method is successful
  61          * @exception           E_SERVICE_BUSY      The database is busy.
  62          * @exception           E_SYSTEM                        The method cannot proceed due to a severe system error.
  63          */
  64         virtual void OnContentScanCompleted(RequestId reqId, const Tizen::Base::String& scanPath, result r) = 0;
  65
  66 protected:
  67
  68         //
  69         // This method is for internal use only.
  70         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  71         //
  72         // This method is reserved and may change its name at any time without prior notice.
  73         //
  74         // @since          2.1
  75         //
  76         virtual void IContentScanListener_Reserved1(void) {}
  77
  78         //
  79         // This method is for internal use only.
  80         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  81         //
  82         // This method is reserved and may change its name at any time without prior notice.
  83         //
  84         // @since          2.1
  85         //
  86         virtual void IContentScanListener_Reserved2(void) {}
  87
  88
  89 };  // class IContentScanListener
  90
  91 }} // Tizen::Content
  92
  93 #endif // _FCNT_ICONTENT_SCAN_LISTENER_H_