//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
*
* @final This class is not intended for extension.
*
- * The %DataControlProviderManager class manages the data control provider.
+ * The %DataControlProviderManager class helps a data control provider application to handle data control requests from other applications and to send results or error message for each data control operation.
*/
class _OSP_EXPORT_ DataControlProviderManager
: public Tizen::Base::Object
public:
/**
- * Sets a SQL-type data control provider listener to the data control provider manager. @n
+ * Sets an SQL-friendly interface based data control provider listener to the data control provider manager. @n
* The listener gets notified when a data control request is received from the other applications.
* To unset the listener, pass a @c null value to the listener parameter.
*
* @since 2.0
*
* @return An error code
- * @param[in] pListener The SQL-type data control provider listener @n
+ * @param[in] pListener The SQL-friendly interface based data control provider listener @n
* The listener must implement the ISqlDataControlProviderEventListener interface.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance has not been properly constructed.
result SetSqlDataControlProviderEventListener(ISqlDataControlProviderEventListener* pListener);
/**
- * Sets a MAP-type data control provider listener to the data control provider manager. @n
+ * Sets a key-value structured data control provider listener to the data control provider manager. @n
* The listener gets notified when a data control request is received from the other applications.
* To unset the listener, pass a @c null value to the listener parameter.
*
* @since 2.0
*
* @return An error code
- * @param[in] pListener The MAP-type data control provider listener @n
+ * @param[in] pListener The key-value structured data control provider listener @n
* The listener must implement the IMapDataControlProviderEventListener interface.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance has not been properly constructed.
result SetMapDataControlProviderEventListener(IMapDataControlProviderEventListener* pListener);
/**
- * Sends the success result and the result set of SELECT request to the application requesting the SQL-type
+ * Sends the success result and the result set of SELECT request to the application requesting the SQL-friendly interface based
* data control. @n
* The data control provider must call the %SendSqlDataControlSelectResult() method to notify success to the requesting application.
* The application requesting the data control can get the success result and the result set
* @exception E_INVALID_ARG Either of the following conditions has occurred:
* - This method cannot send result for the specified @c reqId of INSERT, UPDATE, or DELETE requests.
* - Tizen::Io::Database or Tizen::Io::DbStatement instance associated with the specified @c pDbEnum is deleted.
- * @exception E_OBJ_NOT_FOUND The data control request specified with the @c reqId did not exist.
+ * @exception E_OBJ_NOT_FOUND The data control request specified with the @c reqId does not exist.
* @exception E_OBJECT_LOCKED The database instance associated to the specified @c pDbEnum is locked.
* @exception E_INVALID_FORMAT The database file associated to the specified @c pDbEnum is malformed.
* @exception E_IO Either of the following conditions has occurred:
/**
* Sends the success result of INSERT request and the last inserted row ID to the application requesting
- * the SQL-type data control. @n
+ * the SQL-friendly interface based data control. @n
* The data control provider must call the %SendSqlDataControlInsertResult() method to notify success to the requesting application.
* The application requesting the data control can get the success result and the last inserted row ID
* by implementing Tizen::App::ISqlDataControlResponseListener.
* @param[in] insertRowId The row ID of database changed by INSERT request
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG This method cannot send result for the specified @c reqId of SELECT, UPDATE, or DELETE request.
- * @exception E_OBJ_NOT_FOUND The data control request specified with the @c reqId did not exist.
+ * @exception E_OBJ_NOT_FOUND The data control request specified with the @c reqId does not exist.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @see Tizen::App::DataControlProviderManager::SendSqlDataControlSelectResult()
* @see Tizen::App::DataControlProviderManager::SendSqlDataControlUpdateDeleteResult()
result SendSqlDataControlInsertResult(RequestId reqId, long long insertRowId);
/**
- * Sends the success result of UPDATE / DELETE request to the application requesting the SQL-type data control. @n
+ * Sends the success result of UPDATE / DELETE request to the application requesting the SQL-friendly interface based data control. @n
* The data control provider must call the %SendSqlDataControlUpdateDeleteResult() method to notify success to the requesting application.
* The application requesting the data control can get the success result by implementing Tizen::App::ISqlDataControlResponseListener.
*
* @param[in] reqId The request ID
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG This method cannot send result for the specified @c reqId of SELECT or INSERT request.
- * @exception E_OBJ_NOT_FOUND The data control request specified with the @c reqId did not exist.
+ * @exception E_OBJ_NOT_FOUND The data control request specified with the @c reqId does not exist.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @see Tizen::App::DataControlProviderManager::SendSqlDataControlSelectResult()
* @see Tizen::App::DataControlProviderManager::SendSqlDataControlInsertResult()
result SendSqlDataControlUpdateDeleteResult(RequestId reqId);
/**
- * Sends the success result and the result list of the provider to the application requesting the MAP-type
+ * Sends the success result and the result list of the provider to the application requesting the key-value structured
* data control. @n
* The data control provider must call the %SendMapDataControlResult() method to notify success to the requesting application.
* The application requesting the data control can get the success result and the result set
* @exception E_OBJ_NOT_FOUND The data control request specified with the @c reqId does not exist.
* @exception E_MAX_EXCEEDED The size of sending buffer has exceeded the maximum limit.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @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.
* @see Tizen::App::DataControlProviderManager::SendDataControlError()
* @see Tizen::App::IMapDataControlProviderEventListener
*/
* @param[in] reqId The request ID
* @param[in] errorMsg The provider-defined error message
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The data control request specified with the @c reqId did not exist.
+ * @exception E_OBJ_NOT_FOUND The data control request specified with the @c reqId does not exist.
* @exception E_MAX_EXCEEDED The size of sending buffer has exceeded the maximum limit.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @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.
+ * @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.
* @see Tizen::App::DataControlProviderManager::SendSqlDataControlSelectResult()
* @see Tizen::App::DataControlProviderManager::SendSqlDataControlInsertResult()
* @see Tizen::App::DataControlProviderManager::SendSqlDataControlUpdateDeleteResult()