inc/FSysISettingInfoSetValueAsyncResultListener.h

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