X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFAppISqlDataControlProviderEventListener.h;h=799075090a37ebacc1206130ddefdf8f4fc1ec88;hb=20597a73bc3098301ba91a48378f3ef009c3be96;hp=4a3305ebf43e2a9ef4ab52f71b67440edf9b2777;hpb=9cdc2acce39a2b057b77da1fa02828d068cd7dc6;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FAppISqlDataControlProviderEventListener.h b/inc/FAppISqlDataControlProviderEventListener.h index 4a3305e..7990750 100644 --- a/inc/FAppISqlDataControlProviderEventListener.h +++ b/inc/FAppISqlDataControlProviderEventListener.h @@ -34,11 +34,11 @@ namespace Tizen { namespace App /** * @interface ISqlDataControlProviderEventListener - * @brief This interface defines a listener for dealing with SQL-friendly interface based data control request. + * @brief This interface defines a listener for dealing with an SQL-friendly interface based data control request. * * @since 2.0 * - * The %ISqlDataControlProviderEventListener interface defines a listener for dealing with SQL-friendly interface based data control request. + * The %ISqlDataControlProviderEventListener interface defines a listener for dealing with an SQL-friendly interface based data control request. * * The following example demonstrates how to use the %ISqlDataControlProviderEventListener interface. * @@ -242,7 +242,7 @@ class _OSP_EXPORT_ ISqlDataControlProviderEventListener 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 @@ -250,88 +250,88 @@ public: virtual ~ISqlDataControlProviderEventListener(void) {} /** - * Called when a select request is received from an application using SQL-friendly interface based data control. @n + * Called when the select request is received from an application using an SQL-friendly interface based data control. @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 provider ID for identifying the data control - * @param[in] dataId A string for identifying a specific table to query from @n - * The string consists of one or more components, separated by a slash('/'). - * If the specified @c pColumnList is @c null, all columns are selected. - * @param[in] pColumnList A list of column names to query @n - * The type of objects contained in the specified @c pColumnList is - * Tizen::Base::String class. - * @param[in] pWhere A filter to select desired rows to query @n + * @param[in] providerId The provider ID that identifies the data control + * @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('/') @n + * If the specified @c pColumnList is @c null, all the columns are selected. + * @param[in] pColumnList The list of column names to query @n + * The type of objects contained in the specified @c pColumnList are + * Tizen::Base::String. + * @param[in] pWhere The filter that selects the desired rows to query @n * It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as * column1 = 'stringValue' AND column2 = numericValue. - * @param[in] pOrder The sorting order of rows to query @n + * @param[in] pOrder The sorting order of the rows to query @n * It is an SQL 'ORDER BY' clause excluding the 'ORDER BY' itself. - * @remarks For replying to the data control request, use DataControlProviderManager::SendSqlDataControlSelectResult() - * or DataControlProviderManager::SendDataControlError(). + * @remarks For replying to the data control request, use the DataControlProviderManager::SendSqlDataControlSelectResult() method + * or the DataControlProviderManager::SendDataControlError() method. */ virtual void OnSqlDataControlSelectRequestReceived(RequestId reqId, const Tizen::Base::String& providerId, const Tizen::Base::String& dataId, const Tizen::Base::Collection::IList* pColumnList, const Tizen::Base::String* pWhere, const Tizen::Base::String* pOrder) = 0; /** - * Called when an insert request is received from an application using SQL-friendly interface based data control. @n + * Called when the insert request is received from an application using an SQL-friendly interface based data control. @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 provider ID for identifying the data control - * @param[in] dataId A string for identifying a specific table to insert into @n + * @param[in] providerId The provider ID that identifies the data control + * @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] insertMap The field values in a record to insert @n - * The type of objects contained in the specified @c insertMap is - * Tizen::Base::String class. - * @remarks For replying to the data control request, use DataControlProviderManager::SendSqlDataControlInsertResult() - * or DataControlProviderManager::SendDataControlError(). + * @param[in] insertMap The field values to insert in the record @n + * The type of objects contained in the specified @c insertMap are + * Tizen::Base::String. + * @remarks For replying to the data control request, use the DataControlProviderManager::SendSqlDataControlInsertResult() method + * or the DataControlProviderManager::SendDataControlError() method. */ virtual void OnSqlDataControlInsertRequestReceived(RequestId reqId, const Tizen::Base::String& providerId, const Tizen::Base::String& dataId, const Tizen::Base::Collection::IMap& insertMap) = 0; /** - * Called when an update request is received from an application using SQL-friendly interface based data control. @n + * Called when the update request is received from an application using an SQL-friendly interface based data control. @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 provider ID for identifying the data control - * @param[in] dataId A string for identifying a specific table to update @n + * @param[in] providerId The provider ID that identifies the data control + * @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] updateMap The field values in a record to update @n - * The type of objects contained in the specified @c updateMap is - * Tizen::Base::String class. - * @param[in] pWhere A filter to select desired rows to update @n + * @param[in] updateMap The field values to update in the record @n + * The type of objects contained in the specified @c updateMap are + * Tizen::Base::String. + * @param[in] pWhere The filter to select the desired rows to update @n * It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as * column1 = 'stringValue' AND column2 = numericValue. - * @remarks For replying to the data control request, use DataControlProviderManager::SendSqlDataControlUpdateDeleteResult() - * or DataControlProviderManager::SendDataControlError(). + * @remarks For replying to the data control request, use the DataControlProviderManager::SendSqlDataControlUpdateDeleteResult() method + * or the DataControlProviderManager::SendDataControlError() method. */ virtual void OnSqlDataControlUpdateRequestReceived(RequestId reqId, const Tizen::Base::String& providerId, const Tizen::Base::String& dataId, const Tizen::Base::Collection::IMap& updateMap, const Tizen::Base::String* pWhere) = 0; /** - * Called when a delete request is received from an application using SQL-friendly interface based data control. @n + * Called when the delete request is received from an application using an SQL-friendly interface based data control. @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 provider ID for identifying the data control - * @param[in] dataId A string for identifying a specific table to delete from @n + * @param[in] providerId The provider ID that identifies the data control + * @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] pWhere A filter to select desired rows to delete @n + * @param[in] pWhere The filter to select the desired rows to delete @n * It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as * column1 = 'stringValue' AND column2 = numericValue. - * @remarks For replying to the data control request, use DataControlProviderManager::SendSqlDataControlUpdateDeleteResult() - * or DataControlProviderManager::SendDataControlError(). + * @remarks For replying to the data control request, use the DataControlProviderManager::SendSqlDataControlUpdateDeleteResult() method + * or the DataControlProviderManager::SendDataControlError() method. */ virtual void OnSqlDataControlDeleteRequestReceived(RequestId reqId, const Tizen::Base::String& providerId, const Tizen::Base::String& dataId, const Tizen::Base::String* pWhere) = 0;