* @exception E_OBJ_NOT_FOUND The data control request specified with the @c reqId did 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()
*
* @endcode
*/
+
class _OSP_EXPORT_ MapDataControl
: public Tizen::Base::Object
{
* - The size of sending buffer has exceeded the maximum limit.
* - The number of sending requests has exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @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.
*/
result GetValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, RequestId& reqId, int pageNo = 1, int countPerPage = 20);
* - The size of sending buffer has exceeded the maximum limit.
* - The number of sending requests has exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @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.
*/
result AddValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& value, RequestId& reqId);
* - The size of sending buffer has exceeded the maximum limit.
* - The number of sending requests has exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @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.
*/
result SetValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& oldValue, const Tizen::Base::String& newValue, RequestId& reqId);
* - The size of sending buffer has exceeded the maximum limit.
* - The number of sending requests has exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @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.
*/
result RemoveValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& value, RequestId& reqId);
* @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
* - Access is denied due to insufficient permission.
* - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1
- * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: @n
+ * @exception E_MAX_EXCEEDED Either of the following conditions has occurred:
* - The size of sending buffer has exceeded the maximum limit.
* - The number of sending requests has exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
* @remarks If the value specified in the @c pWhere is string, the value must be wrapped in
* single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.
* For more information on the SQL statement, see SQLite SQL documents.
- * @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.
*/
result Select(const Tizen::Base::String& dataId, const Tizen::Base::Collection::IList* pColumnList,
const Tizen::Base::String* pWhere, const Tizen::Base::String *pOrder, RequestId& reqId,
* @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
* - Access is denied due to insufficient permission.
* - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1
- * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: @n
+ * @exception E_MAX_EXCEEDED Either of the following conditions has occurred:
* - The size of sending buffer has exceeded the maximum limit.
* - The number of sending requests has exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
* @remarks If the value specified in the @c insertMap is string, the value must be wrapped in
* single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.
* For more information on the SQL statement, see SQLite SQL documents.
- * @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.
*/
result Insert(const Tizen::Base::String& dataId, const Tizen::Base::Collection::IMap& insertMap, RequestId& reqId);
* The string consists of one or more components, separated by a slash('/').
* @param[in] updateMap The column-value pairs to update @n
* The type of objects contained in the specified @c updateMap must be
- * Tizen::Base::String class. @n
+ * Tizen::Base::String class.
* @param[in] pWhere A filter to select desired rows to update @n
* It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as
* column1 = 'stringValue' AND column2 = numericValue.
* @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
* - Access is denied due to insufficient permission.
* - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1
- * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: @n
+ * @exception E_MAX_EXCEEDED Either of the following conditions has occurred:
* - The size of sending buffer has exceeded the maximum limit.
* - The number of sending requests has exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
* @remarks If the value specified in the @c pWhere or @c updateMap is string, the value must be wrapped in
* single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.
* For more information on the SQL statement, see SQLITE SQL documents.
- * @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.
*/
result Update(const Tizen::Base::String& dataId, const Tizen::Base::Collection::IMap& updateMap,
const Tizen::Base::String* pWhere, RequestId& reqId);
* @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n
* - Access is denied due to insufficient permission.
* - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1
- * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: @n
+ * @exception E_MAX_EXCEEDED Either of the following conditions has occurred:
* - The size of sending buffer has exceeded the maximum limit.
* - The number of sending requests has exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
* @remarks If the value specified in the @c pWhere is string, the value must be wrapped in
* single quotes. Otherwise it is not needed to wrap the numeric value in single quotes.
* For more information on the SQL statement, see SQLITE SQL documents.
- * @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.
*/
result Delete(const Tizen::Base::String& dataId, const Tizen::Base::String* pWhere, RequestId& reqId);
virtual ~DataRow(void);\r
\r
/**\r
- * Sets a @c ByteBuffer value to the column whose index is specified.\r
+ * Sets a Tizen::Base::ByteBuffer value to the column whose index is specified.\r
*\r
* @since 2.1\r
*\r
* @param[in] columnIndex The index of the column whose value is set @n\r
* The column index starts from 0.\r
* @param[in] pValue The value to set @n\r
- * The specified @c pValue is pointer to user-provided @c ByteBuffer type buffer.\r
+ * The specified @c pValue is a pointer to user-provided Tizen::Base::ByteBuffer type buffer.\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_INVALID_ARG Either of the following conditions has occurred: @n\r
* - The specified @c columnIndex is out of range.\r
- * - The specified @c pValue is null.\r
+ * - The specified @c pValue is @c null.\r
* @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.\r
* @remarks This method performs a shallow copy. It copies only the pointer; not the element itself. @n\r
* The platform will take the ownership of @c pValue after calling this method.\r
\r
\r
/**\r
- * Sets a @c DateTime value to the column whose index is specified.\r
+ * Sets a Tizen::Base::DateTime value to the column whose index is specified.\r
*\r
* @since 2.1\r
*\r
result SetInt64At(int columnIndex, long long value);\r
\r
/**\r
- * Sets a @c String value to the column whose index is specified.\r
+ * Sets a Tizen::Base::String value to the column whose index is specified.\r
*\r
* @since 2.1\r
*\r
* @since 2.1\r
*\r
* @return An error code\r
- * @param[in] columnNames The list of column name to create @n\r
+ * @param[in] columnNames The list of column names to create @n\r
* The object type in the specified list should be String.\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_INVALID_ARG The specified @c columnNames has no element.\r
* @return A pointer to the DataRow instance, @n\r
* else @c null if the memory is insufficient\r
* @remarks The column type is decided by the type of each element inserted in first row.\r
- * If a specific column element on the first row is not inserted, then the column's type is DB_COLUMNTYPE_NULL\r
- * On that case, when a new column element is added later,\r
+ * If a specific column element on the first row is not inserted, then the column's type is @c DB_COLUMNTYPE_NULL\r
+ * In that case, when a new column element is added later,\r
* then the column's type will be changed according to the new element.\r
*/\r
DataRow* CreateDataRowN(void);\r
\r
/**\r
- * Gets table enumerator.\r
+ * Gets a table enumerator.\r
*\r
* @since 2.1\r
*\r
\r
\r
/**\r
- * Get copy of this instance.\r
+ * Gets a copy of this instance.\r
*\r
* @since 2.1\r
*\r
- * @return A pointer to the copy of the DataSet instance, @n\r
-\r
+ * @return A pointer to the copy of the %DataSet instance, @n\r
* else @c null if the memory is insufficient\r
*/\r
DataSet* CloneN(void) const;\r
\r
/**\r
- * Checks whether the value of the specified instance of Object is equal to the value of the current instance of\r
+ * Checks whether the value of a specified instance of Tizen::Base::Object is equal to the value of a current instance of\r
* %DataSet.\r
*\r
* @since 2.1\r
*\r
- * @return @c true if the value of the specified instance of Object is equal to the value of the current\r
+ * @return @c true if the value of the specified instance of Tizen::Base::Object is equal to the value of the current\r
* instance of %DataSet, @n\r
* else @c false\r
- * @param[in] obj An instance of Object to compare\r
- * @remarks The method returns @c false if the specified @c obj is not a %DataSet instance.\r
+ * @param[in] obj An instance of Tizen::Base::Object to compare\r
+ * @remarks This method returns @c false if the specified @c obj is not a %DataSet instance.\r
*/\r
virtual bool Equals(const Tizen::Base::Object& obj) const;\r
\r
/**\r
- * Gets the hash value of the current instance.\r
+ * Gets the hash value of a current instance.\r
*\r
* @since 2.1\r
*\r
* - An unexpected device failure has occurred as the media ejected suddenly. @n\r
* - %File corruption is detected.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
- * @remarks After getting this DataSetEnumerator instance,\r
- * if MoveNext() is called at first, the cursor goes to the first position.\r
+ * @remarks After getting this %DataSetEnumerator instance,\r
+ * if this method is called first, the cursor goes to the first position.\r
* @see Tizen::Io::DataSetEnumerator::MovePrevious()\r
* @see Tizen::Io::DataSetEnumerator::MoveFirst()\r
* @see Tizen::Io::DataSetEnumerator::MoveLast()\r
virtual result GetDoubleAt(int columnIndex, double& value) const;\r
\r
/**\r
- * Gets a @c String value from the column whose index is specified.\r
+ * Gets a Tizen::Base::String value from the column whose index is specified.\r
*\r
* @since 2.1\r
*\r
* @return An error code\r
* @param[in] columnIndex The index of the column whose value is required\r
- * @param[in,out] value The String value obtained from the specified column\r
+ * @param[in,out] value The Tizen::Base::String value obtained from the specified column\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.\r
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.\r
virtual result GetStringAt(int columnIndex, Tizen::Base::String& value) const;\r
\r
/**\r
- * Gets a @c ByteBuffer value from the column whose index is specified.\r
+ * Gets a Tizen::Base::ByteBuffer value from the column whose index is specified.\r
*\r
* @since 2.1\r
*\r
* @return An error code\r
* @param[in] columnIndex The index of the column whose value is required\r
- * @param[in,out] value The ByteBuffer value obtained from the specified column @n\r
- * The ByteBuffer will be filled from the current position and data copy\r
- * will be continued until ByteBuffer limitation is reached or no more\r
- * blob data remains. @n\r
+ * @param[in,out] value The Tizen::Base::ByteBuffer value obtained from the specified column @n\r
+ * The %Tizen::Base::ByteBuffer will be filled from the current position and data copy\r
+ * will be continued until %Tizen::Base::ByteBuffer limitation is reached or no more\r
+ * blob data remains.\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.\r
-\r
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.\r
* @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.\r
- * @exception E_OVERFLOW The specified ByteBuffer @c value is insufficient to save the data.\r
+ * @exception E_OVERFLOW The specified Tizen::Base::ByteBuffer @c value is insufficient to save the data.\r
* @see Tizen::Base::ByteBuffer\r
*/\r
virtual result GetBlobAt(int columnIndex, Tizen::Base::ByteBuffer& value) const;\r
*\r
* @return An error code\r
* @param[in] columnIndex The index of the column whose value is required\r
- * @param[in,out] buffer The user-provided buffer used to receive the blob data @n\r
+ * @param[in,out] buffer The user-provided buffer used to receive the blob data\r
* @param[in] size The maximum buffer length in bytes\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.\r
- * @exception E_INVALID_ARG The specified @c columnIndex is out of range, or the specified @c size is invalid.\r
+ * @exception E_INVALID_ARG Either the specified @c columnIndex is out of range or the specified @c size is invalid.\r
* @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types.\r
* @exception E_OVERFLOW The specified @c buffer is insufficient to save the data.\r
*/\r
virtual result GetBlobAt(int columnIndex, void* buffer, int size) const;\r
\r
/**\r
- * Gets a @c DateTime value from the column whose index is specified.\r
+ * Gets a Tizen::Base::DateTime value from the column whose index is specified.\r
*\r
* @since 2.1\r
*\r
* @return An error code\r
* @param[in] columnIndex The index of the column whose value is required\r
- * @param[in,out] value The DateTime value obtained from the specified column\r
+ * @param[in,out] value The Tizen::Base::DateTime value obtained from the specified column\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.\r
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.\r
* else @c -1 if an exception occurs\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.\r
- * @remarks The method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n\r
+ * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n\r
* The specific error code can be accessed using the GetLastResult() method.\r
*/\r
virtual int GetColumnCount(void) const;\r
\r
/**\r
- * Gets the type of the column indicated by the specified index.\r
+ * Gets the type of the column indicated by a specified index.\r
*\r
* @since 2.1\r
*\r
* @return The type of column, @n\r
- * else DB_COLUMNTYPE_UNDEFINED if an exception occurs\r
+ * else @c DB_COLUMNTYPE_UNDEFINED if an exception occurs\r
* @param[in] columnIndex The index of the destination column\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.\r
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.\r
- * @remarks The method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n\r
- * Currently, DB_COLUMNTYPE_INT is returned for a 64-bit integer. @n\r
+ * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n\r
+ * Currently, @c DB_COLUMNTYPE_INT is returned for a 64-bit integer. @n\r
* The specific error code can be accessed using the GetLastResult() method.\r
*/\r
virtual DbColumnType GetColumnType(int columnIndex) const;\r
\r
/**\r
- * Gets the name of the column indicated by the specified index.\r
+ * Gets the name of the column indicated by a specified index.\r
*\r
* @since 2.1\r
*\r
* @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.\r
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.\r
* @exception E_INVALID_ENCODING_RANGE The string conversion has failed due to invalid encoding range.\r
- * @remarks The method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n\r
+ * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n\r
* The specific error code can be accessed using the GetLastResult() method.\r
*/\r
virtual Tizen::Base::String GetColumnName(int columnIndex) const;\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted.\r
* @exception E_INVALID_ARG The specified @c columnIndex is out of range.\r
- * @remarks The method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n\r
+ * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n\r
* If the destination column is of type String, this method returns the @c byte length excluding\r
* the @c null terminator character. @n\r
* The specific error code can be accessed using the GetLastResult() method.\r
bool IsReadOnly(void) const;
/**
- * Gets the date and time of last modification of the directory entry.
+ * Gets the date and time of the last modification of the directory entry.
*
* @since 2.0
*
- * @return The date and time of last modification
+ * @return The date and time of the last modification
*/
Tizen::Base::DateTime GetDateTime(void) const;
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The @c localMessagePortName is empty.
* @exception E_SYSTEM The method has failed due to a severe system error.
- * @remarks It is not recommended to use the message port names which start with "http://tizen.org/messageport". E_INVALID_ARG may be returned because they are reserved by platform.
+ * @remarks It is not recommended to use the message port names that start with "http://tizen.org/messageport". @c E_INVALID_ARG may be returned because they are reserved by platform.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static LocalMessagePort* RequestLocalMessagePort(const Tizen::Base::String& localMessagePortName);
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The @c localMessagePortName is empty.
* @exception E_SYSTEM The method has failed due to a severe system error.
- * @remarks It is not recommended to use the message port names which start with "http://tizen.org/messageport". E_INVALID_ARG may be returned because they are reserved by platform.
+ * @remarks It is not recommended to use the message port names that start with "http://tizen.org/messageport". @c E_INVALID_ARG may be returned because they are reserved by platform.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static LocalMessagePort* RequestTrustedLocalMessagePort(const Tizen::Base::String& localMessagePortName);
* @exception E_OBJ_NOT_FOUND The message port of the target application is not found.
* @exception E_MAX_EXCEEDED The size of @c pMessage has exceeded the maximum limit.
* @exception E_SYSTEM The method has failed due to a severe system error.
- * @remarks The recommended message size is under 4KB because severe system performance degradation may occur for large messages. E_MAX_EXCEEDED may be returned for messages over 4KB size.
+ * @remarks The recommended message size is under 4KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 4KB size.
*/
result SendMessage(const Tizen::Base::Collection::IMap* pMessage);
* @exception E_OBJ_NOT_FOUND The message port of the target application is not found.
* @exception E_MAX_EXCEEDED The size of @c pMessage has exceeded the maximum limit.
* @exception E_SYSTEM The method has failed due to a severe system error.
- * @remarks The recommended message size is under 4KB because severe system performance degradation may occur for large messages. E_MAX_EXCEEDED may be returned for messages over 4KB size.
+ * @remarks The recommended message size is under 4KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 4KB size.
*/
result SendMessage(const LocalMessagePort* pLocalMessagePort, const Tizen::Base::Collection::IMap* pMessage);
projects / platform / framework / native / appfw.git / commitdiff