inc/FSysISettingInfoSetValueAsyncResultListener.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   4 //
   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
   8 //
   9 //     http://www.apache.org/licenses/LICENSE-2.0
  10 //
  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.
  16 //
  17
  18 /*
  19  * @file        FSysISettingInfoSetValueAsyncResultListener.h
  20  * @brief       This is the header file for the %ISettingInfoSetValueAsyncResultListener interface.
  21  *
  22  * This header file contains the declarations of the %ISettingInfoSetValueAsyncResultListener interface.
  23  */
  24
  25 #ifndef _FSYS_ISETTING_INFO_SET_VALUE_ASYNC_RESULT_LISTENER_H_
  26 #define _FSYS_ISETTING_INFO_SET_VALUE_ASYNC_RESULT_LISTENER_H_
  27
  28 #include <FBaseResult.h>
  29 #include <FBaseRtIEventListener.h>
  30
  31 namespace Tizen { namespace System
  32 {
  33
  34 /**
  35  * @interface   ISettingInfoSetValueAsyncResultListener
  36  * @brief       This interface defines the result listener for an asynchronous setting change method call.
  37  *
  38  * @since 2.0
  39  *
  40  * The %ISettingInfoSetValueAsyncResultListener interface must be registered and implemented by an application to receive result for an asynchronous setting change method call.
  41  *
  42  */
  43 class _OSP_EXPORT_ ISettingInfoSetValueAsyncResultListener
  44         : public virtual Tizen::Base::Runtime::IEventListener
  45 {
  46 public:
  47         /**
  48          * This is the destructor for this class. This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
  49          *
  50          * @since 2.0
  51          */
  52         virtual ~ISettingInfoSetValueAsyncResultListener(void) {}
  53
  54         /**
  55          * Called when a result is received for an asynchronous setting change method call.
  56          *
  57          * @since 2.0
  58          *
  59          * @param[in] key The key name of the changed setting information
  60          * @param[in] r An error code
  61          * @exception E_SUCCESS The result is successful.
  62          * @exception E_SYSTEM  The method cannot proceed due to severe system error.
  63          */
  64
  65         virtual void OnResultReceivedForSetValueAsync(const Tizen::Base::String& key, result r) = 0;
  66
  67 protected:
  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         // @since 2.0
  73         virtual void OnISettingInfoSetValueAsyncResultListener_Reserved1(void) {}
  74
  75         //
  76         // This method is for internal use only.
  77         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  78         //
  79         // @since 2.0
  80         virtual void OnISettingInfoSetValueAsyncResultListener_Reserved2(void) {}
  81
  82         //
  83         // This method is for internal use only.
  84         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  85         //
  86         // @since 2.0
  87         virtual void OnISettingInfoSetValueAsyncResultListener_Reserved3(void) {}
  88         //
  89         // This method is for internal use only.
  90         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  91         //
  92         // @since 2.0
  93         virtual void OnISettingInfoSetValueAsyncResultListener_Reserved4(void) {}
  94
  95         //
  96         // This method is for internal use only.
  97         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  98         //
  99         // @since 2.0
 100         virtual void OnISettingInfoSetValueAsyncResultListener_Reserved5(void) {}
 101
 102         //
 103         // This method is for internal use only.
 104         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 105         //
 106         // @since 2.0
 107         virtual void OnISettingInfoSetValueAsyncResultListener_Reserved6(void) {}
 108         //
 109         // This method is for internal use only.
 110         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 111         //
 112         // @since 2.0
 113         virtual void OnISettingInfoSetValueAsyncResultListener_Reserved7(void) {}
 114
 115         //
 116         // This method is for internal use only.
 117         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 118         //
 119         // @since 2.0
 120         virtual void OnISettingInfoSetValueAsyncResultListener_Reserved8(void) {}
 121
 122         //
 123         // This method is for internal use only.
 124         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 125         //
 126         // @since 2.0
 127         virtual void OnISettingInfoSetValueAsyncResultListener_Reserved9(void) {}
 128
 129 }; // ISettingEventListener
 130
 131 } } // Tizen::System
 132
 133 #endif // _FSYS_ISETTING_INFO_SET_VALUE_ASYNC_RESULT_LISTENER_H_