2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
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
8 // http://www.apache.org/licenses/LICENSE-2.0
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.
18 * @file FAppIMapDataControlResponseListener.h
19 * @brief This is the header file for the %IMapDataControlResponseListener interface.
21 * This header file contains the declarations of the %IMapDataControlResponseListener interface.
24 #ifndef _FAPP_IMAP_DATA_CONTROL_RESPONSE_LISTENER_H_
25 #define _FAPP_IMAP_DATA_CONTROL_RESPONSE_LISTENER_H_
27 #include <FBaseDataType.h>
28 #include <FBaseString.h>
29 #include <FBaseColIList.h>
30 #include <FBaseRtIEventListener.h>
32 namespace Tizen { namespace App
36 * @interface IMapDataControlResponseListener
37 * @brief This interface defines a listener for the key-value structured data control response.
41 * The %IMapDataControlResponseListener interface defines a listener for the key-value structured data control response.
43 class _OSP_EXPORT_ IMapDataControlResponseListener
44 : virtual public Tizen::Base::Runtime::IEventListener
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.
54 virtual ~IMapDataControlResponseListener(void) {}
57 * Called when the result value list is received from the key-value structured data control provider. @n
58 * The application requesting the data control can get the result value list by implementing this listener. @n
59 * This listener must be registered by the MapDataControl::SetMapDataControlResponseListener() method for receiving the result value set.
60 * It is called after the MapDataControl::GetValue() method.
64 * @param[in] reqId The request ID
65 * @param[in] providerId The data control provider ID
66 * @param[in] dataId The string that identifies the specific map to obtain from @n
67 * The string consists of one or more components, separated by a slash('/').
68 * @param[in] resultValueList The result value list of the data control request that gets the matching values @n
69 * The type of objects contained in the specified @c resultValueList are
70 * Tizen::Base::String.
71 * @param[in] providerResult Set to @c true if the data control provider successfully processed the request getting the values, @n
73 * @param[in] pErrorMsg The error message from the data control provider
75 virtual void OnMapDataControlGetValueResponseReceived(RequestId reqId, const Tizen::Base::String& providerId,
76 const Tizen::Base::String& dataId, Tizen::Base::Collection::IList& resultValueList,
77 bool providerResult, const Tizen::Base::String* pErrorMsg) = 0;
80 * Called when the response is received from the key-value structured data control provider. @n
81 * The application requesting the data control can get the result by implementing this listener. @n
82 * This listener must be registered by the MapDataControl::SetMapDataControlResponseListener() method for receiving the result response.
83 * It is called after the MapDataControl::AddValue() method.
87 * @param[in] reqId The request ID
88 * @param[in] providerId The data control provider ID
89 * @param[in] dataId The string that identifies the specific map to add to @n
90 * The string consists of one or more components, separated by a slash('/').
91 * @param[in] providerResult Set to @c true if the data control provider successfully processed the request adding a value, @n
93 * @param[in] pErrorMsg The error message from the data control provider
95 virtual void OnMapDataControlAddValueResponseReceived(RequestId reqId, const Tizen::Base::String& providerId,
96 const Tizen::Base::String& dataId, bool providerResult, const Tizen::Base::String* pErrorMsg) = 0;
99 * Called when the response is received from the key-value structured data control provider. @n
100 * The application requesting the data control can get the result by implementing this listener. @n
101 * This listener must be registered by the MapDataControl::SetMapDataControlResponseListener() method for receiving the result response.
102 * It is called after the MapDataControl::SetValue() method.
106 * @param[in] reqId The request ID
107 * @param[in] providerId The data control provider ID
108 * @param[in] dataId The string that identifies the specific map to update @n
109 * The string consists of one or more components, separated by a slash('/').
110 * @param[in] providerResult Set to @c true if the data control provider successfully processed the request replacing a value, @n
112 * @param[in] pErrorMsg The error message from the data control provider
114 virtual void OnMapDataControlSetValueResponseReceived(RequestId reqId, const Tizen::Base::String& providerId,
115 const Tizen::Base::String& dataId, bool providerResult, const Tizen::Base::String* pErrorMsg) = 0;
118 * Called when the response is received from the key-value structured data control provider. @n
119 * The application requesting the data control can get the result by implementing this listener. @n
120 * This listener must be registered by the MapDataControl::SetMapDataControlResponseListener() method for receiving the result response.
121 * It is called after the MapDataControl::RemoveValue() method.
125 * @param[in] reqId The request ID
126 * @param[in] providerId The data control provider ID
127 * @param[in] dataId The string that identifies the specific map to remove from @n
128 * The string consists of one or more components, separated by a slash('/').
129 * @param[in] providerResult Set to @c true if the data control provider successfully processed the request removing a value, @n
131 * @param[in] pErrorMsg The error message from the data control provider
133 virtual void OnMapDataControlRemoveValueResponseReceived(RequestId reqId, const Tizen::Base::String& providerId,
134 const Tizen::Base::String& dataId, bool providerResult, const Tizen::Base::String* pErrorMsg) = 0;
138 // This method is for internal use only.
139 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
141 // This method is reserved and may change its name at any time without prior notice.
145 virtual void IMapDataControlResponseListener_Reserved1(void) {}
148 // This method is for internal use only.
149 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
151 // This method is reserved and may change its name at any time without prior notice.
155 virtual void IMapDataControlResponseListener_Reserved2(void) {}
158 // This method is for internal use only.
159 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
161 // This method is reserved and may change its name at any time without prior notice.
165 virtual void IMapDataControlResponseListener_Reserved3(void) {}
168 // This method is for internal use only.
169 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
171 // This method is reserved and may change its name at any time without prior notice.
175 virtual void IMapDataControlResponseListener_Reserved4(void) {}
178 // This method is for internal use only.
179 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
181 // This method is reserved and may change its name at any time without prior notice.
185 virtual void IMapDataControlResponseListener_Reserved5(void) {}
187 }; // IMapDataControlResponseListener
191 #endif // _FAPP_IMAP_DATA_CONTROL_RESPONSE_LISTENER_H_