Enable build with iniparser v 3.1

[platform/framework/native/appfw.git] / inc / FAppISqlDataControlResponseListener.h

diff --git a/inc/FAppISqlDataControlResponseListener.h b/inc/FAppISqlDataControlResponseListener.h
index 819d6ef..3418bd3 100644 (file)
--- a/inc/FAppISqlDataControlResponseListener.h
+++ b/inc/FAppISqlDataControlResponseListener.h
@@ -34,11 +34,11 @@ namespace Tizen { namespace App
 
 /**
 *   @interface ISqlDataControlResponseListener
-*   @brief             This interface defines a listener for the SQL-friendly interface based data control response.
+*   @brief             This interface defines a listener for an SQL-friendly interface based data control response.
 *
 *   @since     2.0
 *
-*   The %ISqlDataControlResponseListener interface defines a listener for the SQL-friendly interface based data control response.
+*   The %ISqlDataControlResponseListener interface defines a listener for an SQL-friendly interface based data control response.
 */
 class _OSP_EXPORT_ ISqlDataControlResponseListener
        : virtual public Tizen::Base::Runtime::IEventListener
@@ -46,7 +46,7 @@ class _OSP_EXPORT_ ISqlDataControlResponseListener
 
 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
@@ -54,18 +54,18 @@ public:
        virtual ~ISqlDataControlResponseListener(void) {}
 
        /**
-       * Called when the result set is received from SQL-friendly interface based data control provider. @n
+       * Called when the result set is received from an SQL-friendly interface based data control provider. @n
        * The application requesting the data control can get the query result by implementing this listener. @n
-       * This listener must be registered by SqlDataControl::SetSqlDataControlResponseListener() for receiving the result set.
-       * It is called after SqlDataControl::Select().
+       * This listener must be registered by the SqlDataControl::SetSqlDataControlResponseListener() method for receiving the result set.
+       * It is called after the SqlDataControl::Select() method.
        *
        * @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 table to query from @n
+       * @param[in]    dataId                          The string that identifies the specific table to query from @n
        *                                                                       The string consists of one or more components, separated by a slash('/').
-       * @param[in]    resultSetEnumerator     Navigates the result of data control select request
+       * @param[in]    resultSetEnumerator     Navigates the result of the data control select request
        * @param[in]    providerResult          Set to @c true if the data control provider successfully processed the query request, @n
        *                                                                       else @c false
        * @param[in]    pErrorMsg                       The error message from the data control provider
@@ -74,19 +74,19 @@ public:
                        const Tizen::Base::String& dataId, Tizen::Io::IDbEnumerator& resultSetEnumerator, bool providerResult, const Tizen::Base::String* pErrorMsg) = 0;
 
        /**
-       * Called when the response is received from SQL-friendly interface based data control provider. @n
-       * The application requesting the data control can get insert result by implementing this listener. @n
-       * This listener must be registered by SqlDataControl::SetSqlDataControlResponseListener() for receiving the result response.
-       * It is called after SqlDataControl::Insert().
+       * Called when the response is received from an SQL-friendly interface based data control provider. @n
+       * The application requesting the data control can get the insert result by implementing this listener. @n
+       * This listener must be registered by the SqlDataControl::SetSqlDataControlResponseListener() method for receiving the result response.
+       * It is called after the SqlDataControl::Insert() method.
        *
        * @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 table to insert into @n
+       * @param[in]    dataId                          The string that identifies the specific table to insert into @n
        *                                                                       The string consists of one or more components, separated by a slash('/').
        * @param[in]    insertRowId                     The inserted row ID set by the data control provider if the specified @c providerResult is @c true, @n
-       *                                                                       else @c -1
+       *                                                                       else @c -1 if it fails
        * @param[in]    providerResult          Set to @c true if the data control provider successfully processed the insert request, @n
        *                                                                       else @c false
        * @param[in]    pErrorMsg                       The error message from the data control provider
@@ -95,16 +95,16 @@ public:
                        const Tizen::Base::String& dataId, long long insertRowId, bool providerResult, const Tizen::Base::String* pErrorMsg) = 0;
 
        /**
-       * Called when the response is received from SQL-friendly interface based data control provider. @n
-       * The application requesting the data control can get update result implementing this listener. @n
-       * This listener must be registered by SqlDataControl::SetSqlDataControlResponseListener() for receiving the result response.
-       * It is called after SqlDataControl::Update().
+       * Called when the response is received from an SQL-friendly interface based data control provider. @n
+       * The application requesting the data control can get the update result implementing this listener. @n
+       * This listener must be registered by the SqlDataControl::SetSqlDataControlResponseListener() method for receiving the result response.
+       * It is called after the SqlDataControl::Update() method.
        *
        * @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 table to update @n
+       * @param[in]    dataId                          The string that identifies the specific table to update @n
        *                                                                       The string consists of one or more components, separated by a slash('/').
        * @param[in]    providerResult          Set to @c true if the data control provider successfully processed the update request, @n
        *                                                                       else @c false
@@ -114,16 +114,16 @@ public:
                        const Tizen::Base::String& dataId, bool providerResult, const Tizen::Base::String* pErrorMsg) = 0;
 
        /**
-       * Called when the response is received from SQL-friendly interface based data control provider. @n
-       * The application requesting the data control can get delete result by implementing this listener. @n
-       * This listener must be registered by SqlDataControl::SetSqlDataControlResponseListener() for receiving the result response.
-       * It is called after SqlDataControl::Delete().
+       * Called when the response is received from an SQL-friendly interface based data control provider. @n
+       * The application requesting the data control can get the delete result by implementing this listener. @n
+       * This listener must be registered by the SqlDataControl::SetSqlDataControlResponseListener() method for receiving the result response.
+       * It is called after the SqlDataControl::Delete() method.
        *
        * @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 table to delete from @n
+       * @param[in]    dataId                          The string that identifies the specific table to delete from @n
        *                                                                       The string consists of one or more components, separated by a slash('/').
        * @param[in]    providerResult          Set to @c true if the data control provider successfully processed the delete request, @n
        *                                                                       else @c false