2 // Open Service Platform
3 // Copyright (c) 2013 Samsung Electronics Co., Ltd.
5 // Licensed under the Apache License, Version 2.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
9 // http://www.apache.org/licenses/LICENSE-2.0
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
19 * @file FCntIContentScanListener.h
20 * @brief This is the header file for the %IContentScanListener interface.
22 * This header file contains the declarations of the %IContentScanListener interface.
25 #ifndef _FCNT_ICONTENT_SCAN_LISTENER_H_
26 #define _FCNT_ICONTENT_SCAN_LISTENER_H_
28 #include <FBaseRtIEventListener.h>
30 namespace Tizen { namespace Content
33 * @interface IContentScanListener
34 * @brief This interface is used for receiving the scan operation event.
38 * The %IContentScanListener interface is used for receiving the scan operation event.
40 class _OSP_EXPORT_ IContentScanListener
41 : virtual public Tizen::Base::Runtime::IEventListener
45 * This polymorphic destructor should be overridden if required. @n
46 * This way, the destructors of the derived classes are called when the destructor of this interface is called.
50 virtual ~IContentScanListener(void) {}
53 * Called when a scan operation is completed.
57 * @param[in] reqId The request ID returned by ContentManager::ScanDirectory()
58 * @param[in] scanPath The scan path
59 * @param[in] r The error of scan operation @n
60 * The following exceptions are given through this parameter.
61 * @exception E_SUCCESS The method is successful
62 * @exception E_SERVICE_BUSY The database is busy.
63 * @exception E_SYSTEM The method cannot proceed due to a severe system error.
65 virtual void OnContentScanCompleted(RequestId reqId, const Tizen::Base::String& scanPath, result r) = 0;
70 // This method is for internal use only.
71 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
73 // This method is reserved and may change its name at any time without prior notice.
77 virtual void IContentScanListener_Reserved1(void) {}
80 // This method is for internal use only.
81 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
83 // This method is reserved and may change its name at any time without prior notice.
87 virtual void IContentScanListener_Reserved2(void) {}
90 }; // class IContentScanListener
94 #endif // _FCNT_ICONTENT_SCAN_LISTENER_H_