X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFAppDataControlProviderManager.h;h=0b01c03d9cdc96f41ea335807723d9b9fc691e43;hb=96b0a4ddafe91d06ee856512402a71ee461e9c69;hp=a232f232bb8a9aa97900ae921529e8aed9906a98;hpb=ce380ff0d6dfbf0b1420e0b045f6077f2e124573;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FAppDataControlProviderManager.h b/inc/FAppDataControlProviderManager.h index a232f23..0b01c03 100644 --- a/inc/FAppDataControlProviderManager.h +++ b/inc/FAppDataControlProviderManager.h @@ -1,5 +1,4 @@ // -// Open Service Platform // Copyright (c) 2012 Samsung Electronics Co., Ltd. // // Licensed under the Apache License, Version 2.0 (the License); @@ -55,7 +54,7 @@ class IMapDataControlProviderEventListener; * * @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 @@ -63,14 +62,14 @@ class _OSP_EXPORT_ DataControlProviderManager 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. @@ -82,14 +81,14 @@ public: 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. @@ -101,7 +100,7 @@ public: 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 @@ -116,7 +115,7 @@ public: * @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: @@ -133,7 +132,7 @@ public: /** * 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. @@ -145,7 +144,7 @@ public: * @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() @@ -156,7 +155,7 @@ public: 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. * @@ -166,7 +165,7 @@ public: * @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() @@ -176,7 +175,7 @@ public: 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 @@ -198,7 +197,6 @@ public: * @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_EXCEED may be returned for messages over 16KB size. * @see Tizen::App::DataControlProviderManager::SendDataControlError() * @see Tizen::App::IMapDataControlProviderEventListener */ @@ -216,10 +214,10 @@ public: * @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_EXCEED 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()