//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
/**
* @interface IMapDataControlProviderEventListener
- * @brief This interface defines a listener for dealing with MAP-type data control request.
+ * @brief This interface defines a listener for dealing with a key-value structured data control request.
*
* @since 2.0
*
- * The %IMapDataControlProviderEventListener interface defines a listener for dealing with MAP-type data control request.
+ * The %IMapDataControlProviderEventListener interface defines a listener for dealing with a key-value structured data control request.
*
* The following example demonstrates how to use the %IMapDataControlProviderEventListener interface.
* @code
public:
/**
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
virtual ~IMapDataControlProviderEventListener(void) {}
/**
- * Called when the request for getting the value list is received from MAP-type data control consumer. @n
+ * Called when the request for obtaining the value list is received from the key-value structured data control consumer. @n
* The provider must implement this listener for providing its own data.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific map to get from @n
+ * @param[in] dataId The string that identifies the specific map to obtain from @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] key A key of the value list to obtain
- * @remarks For replying to the data control request, use DataControlProviderManager::SendMapDataControlResult()
- * or DataControlProviderManager::SendDataControlError().
+ * @param[in] key The key of the value list to obtain
+ * @remarks For replying to the data control request, use the DataControlProviderManager::SendMapDataControlResult() method
+ * or the DataControlProviderManager::SendDataControlError() method.
*/
virtual void OnMapDataControlGetValueRequestReceived(RequestId reqId, const Tizen::Base::String& providerId,
const Tizen::Base::String& dataId, const Tizen::Base::String& key) = 0;
/**
- * Called when the request for adding the value is received from MAP-type data control consumer. @n
+ * Called when the request for adding the value is received from the key-value structured data control consumer. @n
* The provider must implement this listener for providing its own data.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific map to add to @n
+ * @param[in] dataId The string that identifies the specific map to add to @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] key A key of the value list to add
- * @param[in] value A value to add
- * @remarks For replying to the data control request, use DataControlProviderManager::SendMapDataControlResult()
- * or DataControlProviderManager::SendDataControlError().
+ * @param[in] key The key of the value list to add
+ * @param[in] value The value to add
+ * @remarks For replying to the data control request, use the DataControlProviderManager::SendMapDataControlResult() method
+ * or the DataControlProviderManager::SendDataControlError() method.
*/
virtual void OnMapDataControlAddValueRequestReceived(RequestId reqId, const Tizen::Base::String& providerId,
const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& value) = 0;
/**
- * Called when the request for replacing the value is received from MAP-type data control consumer. @n
+ * Called when the request for replacing the value is received from the key-value structured data control consumer. @n
* The provider must implement this listener for providing its own data.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific map to update @n
+ * @param[in] dataId The string that identifies the specific map to update @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] key A key of the value to replace
- * @param[in] oldValue A value to replace
- * @param[in] newValue A new value to replace the existing value
- * @remarks For replying to the data control request, use DataControlProviderManager::SendMapDataControlResult()
- * or DataControlProviderManager::SendDataControlError().
+ * @param[in] key The key of the value to replace
+ * @param[in] oldValue The value to replace
+ * @param[in] newValue The new value that replaces the existing value
+ * @remarks For replying to the data control request, use the DataControlProviderManager::SendMapDataControlResult() method
+ * or the DataControlProviderManager::SendDataControlError() method.
*/
virtual void OnMapDataControlSetValueRequestReceived(RequestId reqId, const Tizen::Base::String& providerId,
const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& oldValue,
const Tizen::Base::String& newValue) = 0;
/**
- * Called when the request for removing the value is received from MAP-type data control consumer. @n
+ * Called when the request for removing the value is received from the key-value structured data control consumer. @n
* The provider must implement this listener for providing its own data.
*
* @since 2.0
*
* @param[in] reqId The request ID
* @param[in] providerId The data control provider ID
- * @param[in] dataId A string for identifying a specific map to remove from @n
+ * @param[in] dataId The string that identifies the specific map to remove from @n
* The string consists of one or more components, separated by a slash('/').
- * @param[in] key A key of the value to remove
- * @param[in] value A value to remove
- * @remarks For replying to the data control request, use DataControlProviderManager::SendMapDataControlResult()
- * or DataControlProviderManager::SendDataControlError().
+ * @param[in] key The key of the value to remove
+ * @param[in] value The value to remove
+ * @remarks For replying to the data control request, use the DataControlProviderManager::SendMapDataControlResult() method
+ * or the DataControlProviderManager::SendDataControlError() method.
*/
virtual void OnMapDataControlRemoveValueRequestReceived(RequestId reqId, const Tizen::Base::String& providerId,
const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& value) = 0;
projects / platform / framework / native / appfw.git / blobdiff