//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
/**
* @class MapDataControl
- * @brief This class represents the MAP-type data control behavior.
+ * @brief This class represents the key-value structured data control behavior.
*
* @since 2.0
*
* @final This class is not intended for extension.
*
- * The %MapDataControl class represents the MAP-type data control behavior, that provides a standard mechanism
+ * The %MapDataControl class represents the key-value structured data control behavior, that provides a standard mechanism
* for accessing specific data exported by other applications.
* Data control provider can share its own data to data control consumers.
*
*
* @see Tizen::App::AppManager
*
+ * The following example demonstrates how to use the %MapDataControl class.
+ *
* @code
*
* #include <FBase.h>
*
* @endcode
*/
+
class _OSP_EXPORT_ MapDataControl
: public Tizen::Base::Object
{
virtual ~MapDataControl(void);
/**
- * Gets the value list associated with the specified @c key, from a key-values map owned by MAP-type data control provider. @n
+ * Gets the value list associated with the specified @c key, from a key-values map owned by key-value structured data control provider. @n
* The %GetValue() method is asynchronous.
* For receiving the response from data control provider, set the listener
* with MapDataControl::SetMapDataControlResponseListener(). @n
* - Access is denied due to insufficient permission.
* - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1
* @exception E_MAX_EXCEEDED Either of the following conditions has occurred: @n
- * - The size of sending buffer has exceeded the maximum limit.
- * - The number of sending requests has exceeded the maximum limit.
+ * - The total size of method arguments has exceeded the maximum limit.
+ * - The number of requests sent has exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The recommended data size is under 16KB because severe system performance degradation may occur for large messages. E_MAX_EXCEEDED may be returned for messages over 16KB size.
+ * @remarks The total size of method arguments is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.
*/
result GetValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, RequestId& reqId, int pageNo = 1, int countPerPage = 20);
/**
- * Adds the value associated with the specified @c key, to a key-values map owned by MAP-type data control provider. @n
+ * Adds the value associated with the specified @c key, to a key-values map owned by key-value structured data control provider. @n
* The %AddValue() method is asynchronous.
* For receiving the response from data control provider, set the listener
* with MapDataControl::SetMapDataControlResponseListener(). @n
* - Access is denied due to insufficient permission.
* - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1
* @exception E_MAX_EXCEEDED Either of the following conditions has occurred: @n
- * - The size of sending buffer has exceeded the maximum limit.
- * - The number of sending requests has exceeded the maximum limit.
+ * - The total size of method arguments has exceeded the maximum limit.
+ * - The number of requests sent has exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The recommended data size is under 16KB because severe system performance degradation may occur for large messages. E_MAX_EXCEEDED may be returned for messages over 16KB size.
+ * @remarks The total size of method arguments is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.
*/
result AddValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& value, RequestId& reqId);
/**
* Sets the value associated with the specified @c key with a new value. @n
- * The key-values map is owned by MAP-type data control provider. @n
+ * The key-values map is owned by key-value structured data control provider. @n
* The %SetValue() method is asynchronous.
* For receiving the response from data control provider, set the listener
* with MapDataControl::SetMapDataControlResponseListener(). @n
* - Access is denied due to insufficient permission.
* - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1
* @exception E_MAX_EXCEEDED Either of the following conditions has occurred: @n
- * - The size of sending buffer has exceeded the maximum limit.
- * - The number of sending requests has exceeded the maximum limit.
+ * - The total size of method arguments has exceeded the maximum limit.
+ * - The number of requests sent has exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The recommended data size is under 16KB because severe system performance degradation may occur for large messages. E_MAX_EXCEEDED may be returned for messages over 16KB size.
+ * @remarks The total size of method arguments is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.
*/
result SetValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& oldValue, const Tizen::Base::String& newValue, RequestId& reqId);
/**
- * Removes the value associated with the specified @c key, from a key-values map owned by MAP-type data control provider. @n
+ * Removes the value associated with the specified @c key, from a key-values map owned by key-value structured data control provider. @n
* The %RemoveValue() method is asynchronous.
* For receiving the response from data control provider, set the listener
* with MapDataControl::SetMapDataControlResponseListener(). @n
* - Access is denied due to insufficient permission.
* - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1
* @exception E_MAX_EXCEEDED Either of the following conditions has occurred: @n
- * - The size of sending buffer has exceeded the maximum limit.
- * - The number of sending requests has exceeded the maximum limit.
+ * - The total size of method arguments has exceeded the maximum limit.
+ * - The number of requests sent has exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The recommended data size is under 16KB because severe system performance degradation may occur for large messages. E_MAX_EXCEEDED may be returned for messages over 16KB size.
+ * @remarks The total size of method arguments is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.
*/
result RemoveValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& value, RequestId& reqId);
projects / platform / framework / native / appfw.git / blobdiff