//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
/**
* @class SqlDataControl
- * @brief This class represents the SQL-type data control behavior.
+ * @brief This class represents the SQL-friendly interface based data control behavior.
*
* @since 2.0
*
/**
* Selects the specified columns to be queried. @n
- * The result set of the specified columns is retrieved from a table owned by an SQL-type data control provider. @n
+ * The result set of the specified columns is retrieved from a table owned by an SQL-friendly interface based data control provider. @n
* The %Select() method is asynchronous.
* For receiving the response from the data control provider, set the listener with
* SqlDataControl::SetSqlDataControlResponseListener(). @n
* If the specified @c pColumnList is @c null, all columns are selected.
* @param[in] pWhere A filter to select desired rows to query @n
* It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as
- * column1 = 'stringValue' AND column2 = numericValue.
+ * column1 = 'stringValue' AND column2 = numericValue. @n\r
+ * If the value is string, the value must be wrapped in single quotes.\r
+ * Otherwise it is not needed to wrap the numeric value in single quotes.\r
+ * For more information on the SQL statement, see SQLite SQL documents.\r
* @param[in] pOrder The sorting order of rows to query @n
* It is an SQL 'ORDER BY' clause excluding the 'ORDER BY' itself.
* @param[out] reqId The request ID
* @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:
+ * @exception E_MAX_EXCEEDED Either of the following conditions has occurred:
* - 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. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.
+ * @remarks The recommended data size 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.\r
*/
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,
int pageNo = 1, int countPerPage = 20);
/**
- * Inserts new rows into a table owned by an SQL-type data control provider. @n
+ * Inserts new rows into a table owned by an SQL-friendly interface based data control provider. @n
* The %Insert() method is asynchronous.
* For receiving the response from the data control provider, set the listener with
* SqlDataControl::SetSqlDataControlResponseListener(). @n
* @param[in] dataId A string for identifying specific data, usually a database table to insert into @n
* The string consists of one or more components, separated by a slash('/').
* @param[in] insertMap The column-value pairs to insert @n
- * The type of objects contained in the specified @c insertMap must be
- * Tizen::Base::String class.
+ * The type of objects must be Tizen::Base::String class. @n\r
+ * If the value is string, the value must be wrapped in\r
+ * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.\r
+ * For more information on the SQL statement, see SQLite SQL documents.\r
* @param[out] reqId The request ID
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance has not been properly constructed.
* @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:
+ * @exception E_MAX_EXCEEDED Either of the following conditions has occurred:
* - 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. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.
+ * @remarks The recommended data size is under 1MB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 1MB size.\r
*/
result Insert(const Tizen::Base::String& dataId, const Tizen::Base::Collection::IMap& insertMap, RequestId& reqId);
/**
- * Updates values of a table owned by an SQL-type data control provider. @n
+ * Updates values of a table owned by an SQL-friendly interface based data control provider. @n
* The %Update() method is asynchronous.
* For receiving the response from the data control provider, set the listener with
* SqlDataControl::SetSqlDataControlResponseListener(). @n
* @param[in] dataId A string for identifying specific data, usually a database table to update @n
* The string consists of one or more components, separated by a slash('/').
* @param[in] updateMap The column-value pairs to update @n
- * The type of objects contained in the specified @c updateMap must be
- * Tizen::Base::String class.
+ * The type of objects must be Tizen::Base::String class. @n\r
+ * If the value is string, the value must be wrapped in\r
+ * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.\r
+ * For more information on the SQL statement, see SQLITE SQL documents.\r
* @param[in] pWhere A filter to select desired rows to update @n
* It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as
- * column1 = 'stringValue' AND column2 = numericValue.
+ * column1 = 'stringValue' AND column2 = numericValue. @n\r
+ * If the value is string, the value must be wrapped in\r
+ * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.\r
+ * For more information on the SQL statement, see SQLITE SQL documents.\r
* @param[out] reqId The request ID
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance has not been properly constructed.
* @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:
+ * @exception E_MAX_EXCEEDED Either of the following conditions has occurred:
* - 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. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.
+ * @remarks The recommended data size is under 1MB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 1MB size.\r
*/
result Update(const Tizen::Base::String& dataId, const Tizen::Base::Collection::IMap& updateMap,
const Tizen::Base::String* pWhere, RequestId& reqId);
/**
- * Deletes rows of a table owned by an SQL-type data control provider. @n
+ * Deletes rows of a table owned by an SQL-friendly interface based data control provider. @n
* The %Delete() method is asynchronous.
* For receiving the response from the data control provider, set the listener with
* SqlDataControl::SetSqlDataControlResponseListener(). @n
* @param[in] pWhere A filter to select desired rows to delete @n
* It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as
* column1 = 'stringValue' AND column2 = numericValue.
- * If it is @c null, all rows are deleted.
+ * If it is @c null, all rows are deleted. @n\r
+ * If the value is string, the value must be wrapped in\r
+ * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.\r
+ * For more information on the SQL statement, see SQLITE SQL documents.\r
* @param[out] reqId The request ID
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance has not been properly constructed.
* @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:
+ * @exception E_MAX_EXCEEDED Either of the following conditions has occurred:
* - 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. @c E_MAX_EXCEEDED may be returned for messages over 16KB size.
+ * @remarks The recommended data size 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.\r
*/
result Delete(const Tizen::Base::String& dataId, const Tizen::Base::String* pWhere, RequestId& reqId);
/**
- * Sets an SQL-type data control listener to this instance.
+ * Sets an SQL-friendly interface based data control listener to this instance.
*
* @since 2.0
*
projects / platform / framework / native / appfw.git / blobdiff