Flow control for DataControl
[platform/framework/native/appfw.git] / inc / FAppSqlDataControl.h
old mode 100644 (file)
new mode 100755 (executable)
index f5445ab..9c3d38e
@@ -101,16 +101,21 @@ public:
        * @param[in]    countPerPage            The desired maximum count of rows on a page
        * @exception    E_SUCCESS                       The method is successful.
        * @exception    E_INVALID_STATE         This instance has not been properly constructed.
-       * @exception    E_INVALID_ARG           Either of the following conditions has occurred:
+       * @exception    E_INVALID_ARG           Either of the following conditions has occurred: @n
        *                                                                       - The specified @c pColumnList is empty.
        *                                                                       - The specified @c pageNo parameter is less than @c 1.
        *                                                                       - The specified @c countPerPage parameter is less than @c 1.
-       * @exception    E_ILLEGAL_ACCESS        Access is denied due to insufficient permission.
-       * @exception    E_OUT_OF_MEMORY         The memory is insufficient.
+       * @exception    E_ILLEGAL_ACCESS        Either of the following conditions has occurred: @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.
        * @exception    E_SYSTEM                        A system error has occurred.
        * @remarks              If the value specified in the @c pWhere is string, the value must be wrapped in
        *                               single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.
        *                               For more information on the SQL statement, see SQLite SQL documents.
+       * @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.
        */
        result Select(const Tizen::Base::String& dataId, const Tizen::Base::Collection::IList* pColumnList,
                        const Tizen::Base::String* pWhere, const Tizen::Base::String *pOrder, RequestId& reqId,
@@ -136,12 +141,17 @@ public:
        * @exception    E_SUCCESS                       The method is successful.
        * @exception    E_INVALID_STATE         This instance has not been properly constructed.
        * @exception    E_INVALID_ARG           The specified @c insertMap is empty.
-       * @exception    E_ILLEGAL_ACCESS        Access is denied due to insufficient permission.
-       * @exception    E_OUT_OF_MEMORY         The memory is insufficient.
+       * @exception    E_ILLEGAL_ACCESS        Either of the following conditions has occurred: @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.
        * @exception    E_SYSTEM                        A system error has occurred.
        * @remarks              If the value specified in the @c insertMap is string, the value must be wrapped in
        *                               single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.
        *                               For more information on the SQL statement, see SQLite SQL documents.
+       * @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.
        */
        result Insert(const Tizen::Base::String& dataId, const Tizen::Base::Collection::IMap& insertMap, RequestId& reqId);
 
@@ -168,12 +178,17 @@ public:
        * @exception    E_SUCCESS                       The method is successful.
        * @exception    E_INVALID_STATE         This instance has not been properly constructed.
        * @exception    E_INVALID_ARG           The specified @c updateMap is empty.
-       * @exception    E_ILLEGAL_ACCESS        Access is denied due to insufficient permission.
-       * @exception    E_OUT_OF_MEMORY         The memory is insufficient.
+       * @exception    E_ILLEGAL_ACCESS        Either of the following conditions has occurred: @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.
        * @exception    E_SYSTEM                        A system error has occurred.
        * @remarks              If the value specified in the @c pWhere or @c updateMap is string, the value must be wrapped in
        *                               single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.
        *                               For more information on the SQL statement, see SQLITE SQL documents.
+       * @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.
        */
        result Update(const Tizen::Base::String& dataId, const Tizen::Base::Collection::IMap& updateMap,
                        const Tizen::Base::String* pWhere, RequestId& reqId);
@@ -199,12 +214,17 @@ public:
        * @exception    E_SUCCESS                       The method is successful.
        * @exception    E_INVALID_STATE         This instance has not been properly constructed.
        * @exception    E_INVALID_ARG           A specified parameter is invalid.
-       * @exception    E_ILLEGAL_ACCESS        Access is denied due to insufficient permission.
-       * @exception    E_OUT_OF_MEMORY         The memory is insufficient.
+       * @exception    E_ILLEGAL_ACCESS        Either of the following conditions has occurred: @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.
        * @exception    E_SYSTEM                        A system error has occurred.
        * @remarks              If the value specified in the @c pWhere is string, the value must be wrapped in
        *                               single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.
        *                               For more information on the SQL statement, see SQLITE SQL documents.
+       * @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.
        */
        result Delete(const Tizen::Base::String& dataId, const Tizen::Base::String* pWhere, RequestId& reqId);