/**
* @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.
*
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
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;
projects / platform / framework / native / appfw.git / blobdiff