inc/FCntIContentUpdateEventListener.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                FCntIContentUpdateEventListener.h
  19  * @brief               This is the header file for the %IContentUpdateEventListener interface.
  20  *
  21  * This header file contains the declarations of the %IContentUpdateEventListener interface.
  22  */
  23
  24 #ifndef _FCNT_ICONTENT_UPDATE_EVENT_LISTENER_H_
  25 #define _FCNT_ICONTENT_UPDATE_EVENT_LISTENER_H_
  26
  27 #include <FBaseRtIEventListener.h>
  28
  29 namespace Tizen { namespace Content
  30 {
  31 /**
  32  * @interface   IContentUpdateEventListener
  33  * @brief               This interface is used for receiving the database change notification.
  34  *
  35  * @since 2.1
  36  *
  37  * The %IContentUpdateEventListener interface is used for receiving the database change notification.
  38  */
  39 class _OSP_EXPORT_ IContentUpdateEventListener
  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 ~IContentUpdateEventListener(void) {}
  50
  51         /**
  52          * Called when the content is created.
  53          *
  54          * @since                               2.1
  55          *
  56          * @param[in]                   contentId                       The content ID
  57          * @param[in]                   contentType             The content type
  58          * @param[in]                   r                                       An error code @n
  59          *                                                                                      The following exceptions are given through this parameter.
  60          * @exception                   E_SUCCESS                       The method is successful.
  61          * @exception                   E_SYSTEM                        The method cannot proceed due to a severe system error.
  62          */
  63         virtual void OnContentFileCreated(ContentId contentId, ContentType contentType, result r) = 0;
  64
  65     /**
  66     * Called when the content is updated.
  67     *
  68     * @since                            2.1
  69     *
  70     * @param[in]                        contentId                       The content ID
  71     * @param[in]                        contentType             The content type
  72     * @param[in]                        r                                       An error code @n
  73     *                                                                                   The following exceptions are given through this parameter.
  74     * @exception                        E_SUCCESS                       The method is successful.
  75     * @exception                        E_SYSTEM                        The method cannot proceed due to a severe system error.
  76     */
  77     virtual void OnContentFileUpdated(ContentId contentId, ContentType contentType, result r) = 0;
  78
  79         /**
  80          * Called when the content is deleted.
  81          *
  82          * @since                               2.1
  83          *
  84          * @param[in]                   contentId                       The content ID
  85          * @param[in]                   contentType             The content type
  86          * @param[in]                   r                                       An error code @n
  87          *                                                                                      The following exceptions are given through this parameter.
  88          * @exception                   E_SUCCESS                       The method is successful.
  89          * @exception                   E_SYSTEM                        The method cannot proceed due to a severe system error.
  90          */
  91         virtual void OnContentFileDeleted(ContentId contentId, ContentType contentType, result r) = 0;
  92
  93         /**
  94          * Called when the scan for a directory is completed.
  95          *
  96          * @since                               2.1
  97          *
  98          * @param[in]                   directoryPath           The directory path
  99          * @param[in]                   r                                       An error code @n
 100          *                                                                                      The following exceptions are given through this parameter.
 101          * @exception                   E_SUCCESS                       The method is successful.
 102          * @exception                   E_SYSTEM                        The method cannot proceed due to a severe system error.
 103          */
 104         virtual void OnContentDirectoryScanCompleted(const Tizen::Base::String& directoryPath, result r) = 0;
 105
 106 protected:
 107         //
 108         // This method is for internal use only.
 109         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 110         //
 111         // This method is reserved and may change its name at any time without prior notice.
 112         //
 113         // @since          2.1
 114         //
 115         virtual void IContentUpdateEventListener_Reserved1(void) {}
 116
 117         //
 118         // This method is for internal use only.
 119         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 120         //
 121         // This method is reserved and may change its name at any time without prior notice.
 122         //
 123         // @since          2.1
 124         //
 125         virtual void IContentUpdateEventListener_Reserved2(void) {}
 126
 127         //
 128         // This method is for internal use only.
 129         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 130         //
 131         // This method is reserved and may change its name at any time without prior notice.
 132         //
 133         // @since          2.1
 134         //
 135         virtual void IContentUpdateEventListener_Reserved3(void) {}
 136
 137         //
 138         // This method is for internal use only.
 139         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 140         //
 141         // This method is reserved and may change its name at any time without prior notice.
 142         //
 143         // @since          2.1
 144         //
 145         virtual void IContentUpdateEventListener_Reserved4(void) {}
 146
 147         //
 148         // This method is for internal use only.
 149         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 150         //
 151         // This method is reserved and may change its name at any time without prior notice.
 152         //
 153         // @since          2.1
 154         //
 155         virtual void IContentUpdateEventListener_Reserved5(void) {}
 156
 157 };  // class IContentUpdateEventListener
 158
 159 }} // Tizen::Content
 160
 161 #endif // _FCNT_ICONTENT_UPDATE_EVENT_LISTENER_H_