fixed Doxygen warning
[platform/framework/native/appfw.git] / inc / FSysIRuntimeInfoGetIntAsyncResultListener.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 FSysIRuntimeInfoGetIntAsyncResultListener.h
19 * @brief          This is the header file for the %IRuntimeInfoGetIntAsyncResultListener interface.
20 *
21 * This header file contains the declarations of the %IRuntimeInfoGetIntAsyncResultListener interface.
22 */
23  
24 #ifndef _FSYS_IRUNTIME_INFO_GET_INT_ASYNC_RESULT_LISTENER_H_
25 #define _FSYS_IRUNTIME_INFO_GET_INT_ASYNC_RESULT_LISTENER_H_
26  
27 #include <FBaseResult.h>
28 #include <FBaseRtIEventListener.h>
29  
30 namespace Tizen { namespace System
31 {
32  
33 /**
34 * @interface    IRuntimeInfoGetIntAsyncResultListener
35 * @brief                This interface defines the result listener for an asynchronous method call to the %RuntimeInfo class.
36 *
37 * @since 2.0
38 *
39 * The %IRuntimeInfoGetIntAsyncResultListener interface defines the result listener for an asynchronous method call to the 
40 * RuntimeInfo class. An instance of this interface is removed automatically by the platform, after result is notified.
41 *
42 */
43 class _OSP_EXPORT_ IRuntimeInfoGetIntAsyncResultListener
44            : public virtual Tizen::Base::Runtime::IEventListener
45 {
46 public:
47            /**
48            * This polymorphic destructor should be overridden if required. @n
49            * This way, the destructors of the derived classes are when the destructor of this interface is called.
50            *
51            * @since 2.0
52            */
53            virtual ~ IRuntimeInfoGetIntAsyncResultListener (void) {}
54            /**
55            * Called when a result received from an asynchronous method call is a key of type @c int.
56            *
57            * @since 2.0
58            *
59            * @param[in]         value           The @c int type runtime 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 a severe system error.
63            */
64            virtual void OnResultReceivedForGetValueAsync(int value, result r) = 0;
65  
66 protected:
67            //
68            // This method is for internal use only.
69            // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
70            //
71            // @since 2.0
72            virtual void IGetValueAsyncResultListener_Reserved1 (void){}
73  
74            //
75            // This method is for internal use only.
76            // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
77            //
78            // @since 2.0
79            virtual void IGetValueAsyncResultListener_Reserved2 (void){}
80  
81            //
82            // This method is for internal use only.
83            // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
84            //
85            // @since 2.0
86            virtual void IGetValueAsyncResultListener_Reserved3 (void){}
87  
88 }; // IRuntimeInfoGetIntAsyncResultListener
89  
90 } } // Tizen::System
91 #endif // _FSYS_IRUNTIME_INFO_GET_INT_ASYNC_RESULT_LISTENER_H_
92