X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFIoIDbEnumerator.h;h=12b59240859ce2766c9e050b4e0608b965c70216;hb=376b1791f5888970901326fa60f67431fa701a4d;hp=d45f1c29241610a8984711ef6e6db8ccddc58ce9;hpb=6b44196c40a66b895028f7ba2e9b5e41bc715ab2;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FIoIDbEnumerator.h b/inc/FIoIDbEnumerator.h index d45f1c2..12b5924 100644 --- a/inc/FIoIDbEnumerator.h +++ b/inc/FIoIDbEnumerator.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); @@ -46,7 +45,8 @@ class _OSP_EXPORT_ IDbEnumerator public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called. + * 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 */ @@ -59,15 +59,15 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to move the cursor position of the result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_OUT_OF_RANGE The enumerator has reached out of the result set returned by the SELECT query. * @exception E_OBJECT_LOCKED The database instance is locked. * @exception E_INVALID_FORMAT The database file is malformed. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ @@ -80,15 +80,15 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to move the cursor position of the result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_OUT_OF_RANGE The enumerator has reached out of the result set returned by the SELECT query. * @exception E_OBJECT_LOCKED The database instance is locked. * @exception E_INVALID_FORMAT The database file is malformed. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ @@ -101,14 +101,14 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to move the cursor position of the result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_OBJECT_LOCKED The database instance is locked. * @exception E_INVALID_FORMAT The database file is malformed. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ @@ -121,174 +121,172 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to move the cursor position of the result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_OBJECT_LOCKED The database instance is locked. * @exception E_INVALID_FORMAT The database file is malformed. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ virtual result MoveLast(void) = 0; /** - * Resets the calling %IDbEnumerator instance back to its initial state. + * Resets the calling %IDbEnumerator instance to its initial state. * * @since 2.0 * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to reset the enumerator of the result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_OBJECT_LOCKED The database instance is locked. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks After this method is called, if MoveNext() is called the cursor goes to the first position. + * @remarks If MoveNext() is called after this method, the cursor goes to the first position. */ virtual result Reset(void) = 0; /** - * Gets an @c int value from the column whose index is specified. + * Gets the @c int value from the column with the specified index. * * @since 2.0 * * @return An error code - * @param[in] columnIndex The index of the column whose value is required + * @param[in] columnIndex The index of the column to get the value * @param[in,out] value The integer value obtained from the column * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. */ virtual result GetIntAt(int columnIndex, int& value) const = 0; /** - * Gets a @c long @c long value from the column whose index is specified. + * Gets the @c long @c long value from the column with the specified index. * * @since 2.0 * * @return An error code - * @param[in] columnIndex The index of the column whose value is required + * @param[in] columnIndex The index of the column to get the value * @param[in,out] value The 64-bit integer value obtained from the column * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. */ virtual result GetInt64At(int columnIndex, long long& value) const = 0; /** - * Gets a @c double value from the column whose index is specified. + * Gets the @c double value from the column with the specified index. * * @since 2.0 * * @return An error code - * @param[in] columnIndex The index of the column whose value is required - * @param[in,out] value The value obtained from the column as a double + * @param[in] columnIndex The index of the column to get the value + * @param[in,out] value The double value obtained from the column * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. */ virtual result GetDoubleAt(int columnIndex, double& value) const = 0; /** - * Gets a @c String value from the column whose index is specified. + * Gets the @c String value from the column with the specified index. * * @since 2.0 * * @return An error code - * @param[in] columnIndex The index of the column whose value is required - * @param[in,out] value The value obtained from the column as a String + * @param[in] columnIndex The index of the column to get the value + * @param[in,out] value The @c String value obtained from the column * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. - * @exception E_INVALID_ENCODING_RANGE The string conversion has failed due to invalid encoding range, or - * it is possible if the database file is corrupted. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. + * @exception E_INVALID_ENCODING_RANGE Either of the following conditions has occurred: + * - The string conversion has failed due to invalid encoding range. + * - The database file is corrupted. */ virtual result GetStringAt(int columnIndex, Tizen::Base::String& value) const = 0; /** - * Gets a byte array value from the column whose index is specified. + * Gets the byte array value from the column with the specified index. * * @since 2.0 * * @return An error code - * @param[in] columnIndex The index of the column whose value is required - * @param[in,out] value The user-provided buffer used to receive the blob data as a stream of type ByteBuffer @n - * The buffer will be filled from the current position and data copy will be continued - * until buffer limitation is reached or no more blob data remains. @n + * @param[in] columnIndex The index of the column to get the value + * @param[in,out] value The buffer used to receive the blob data as a stream of type ByteBuffer @n + * The buffer will be filled from the current position and the data copying will be continued + * until the buffer limitation is reached or no more blob data remains. @n * The maximum size available is limited to 100 MByte. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. * @exception E_OUT_OF_RANGE The byte buffer operation has failed. * @exception E_OVERFLOW The specified @c value of the byte buffer is insufficient to save the data. */ virtual result GetBlobAt(int columnIndex, Tizen::Base::ByteBuffer& value) const = 0; /** - * Gets a blob data from the column whose index is specified. + * Gets the blob data from the column with the specified index. * * @since 2.0 * * @return An error code - * @param[in] columnIndex The index of the column whose value is required - * @param[in,out] buffer The user-provided buffer used to receive the blob data @n + * @param[in] columnIndex The index of the column to get the value + * @param[in,out] buffer The buffer used to receive the blob data @n * The maximum size available is limited to 100 MByte. * @param[out] size The maximum buffer length in bytes * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_INVALID_ARG The specified @c columnIndex is out of range, or the specified @c size is invalid. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. * @exception E_OVERFLOW The specified @c buffer is insufficient to save the data. */ virtual result GetBlobAt(int columnIndex, void* buffer, int size) const = 0; /** - * Gets a @c DateTime value from the column whose index is specified. + * Gets the @c DateTime value from the column with the specified index. * * @since 2.0 * * @return An error code - * @param[in] columnIndex The index of the column whose value is required + * @param[in] columnIndex The index of the column to get the value * @param[in,out] value The value obtained from the column as a DateTime instance * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. - * @exception E_INVALID_FORMAT The date is not correctly formatted, or the method is trying to access column of type String. @n - * The date format should be 'mm/dd/yyyy hh:mm:ss'. - * @exception E_OUT_OF_RANGE Either the year(%d), month(%d), day(%d), hour(%d), minute(%d), or second(%d) value is out of range, - * or the method is trying to access a column of type String. - * @remarks Note that the DateTime is constructed inside the method. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. + * @exception E_INVALID_FORMAT The date is not correctly formatted. The date format should be 'mm/dd/yyyy hh:mm:ss'. + * @exception E_OUT_OF_RANGE Either the year, month, day, hour, minute, or second value is out of range, or the method is trying to access a column having an invalid value. */ virtual result GetDateTimeAt(int columnIndex, Tizen::Base::DateTime& value) const = 0; @@ -297,76 +295,81 @@ public: * * @since 2.0 * - * @return The number of columns in the calling enumerator, @n + * @return The number of columns in the current enumerator, @n * else @c -1 if an exception occurs * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n - * @remarks The method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n - * The specific error code can be accessed using the GetLastResult() method. + * (the query did not yield any result). + * @remarks + * - The method must be called after MoveNext(), MoveFirst(), or MoveLast(). + * - The specific error code can be accessed using the GetLastResult() method. */ virtual int GetColumnCount(void) const = 0; /** - * Gets the type of the column indicated by the specified index. + * Gets the type of the column specified by the index. * * @since 2.0 * - * @return The type of column, @n - * else DB_COLUMNTYPE_UNDEFINED if an exception occurs - * @param[in] columnIndex The index of the destination column + * @return The column type, @n + * else @c DB_COLUMNTYPE_UNDEFINED if an exception occurs + * @param[in] columnIndex The column index * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @remarks The method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n - * Currently, DB_COLUMNTYPE_INT is returned for a 64-bit integer. @n - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - This method must be called after MoveNext(), MoveFirst(), or MoveLast(). + * - Currently, @c DB_COLUMNTYPE_INT is returned for a 64-bit integer. + * - The specific error code can be accessed using the GetLastResult() method. */ virtual DbColumnType GetColumnType(int columnIndex) const = 0; /** - * Gets the name of the column indicated by the specified index. + * Gets the name of the column specified by the index. * * @since 2.0 * * @return The name of the column, @n * else an empty string if an exception occurs - * @param[in] columnIndex The index of the destination column + * @param[in] columnIndex The column index * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_INVALID_ENCODING_RANGE The string conversion has failed due to invalid encoding range, or - * it is possible if the database file is corrupted. - * @remarks The method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n - * The specific error code can be accessed using the GetLastResult() method. + * @exception E_INVALID_ENCODING_RANGE Either of the following conditions has occurred: + * - The string conversion has failed due to invalid encoding range. + * - The database file is corrupted. + * @remarks + * - This method must be called after MoveNext(), MoveFirst(), or MoveLast(). + * - The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::String GetColumnName(int columnIndex) const = 0; /** - * Gets the size of data in bytes. + * Gets the size of data in bytes of the column specified by the index. * * @since 2.0 * * @return The size of the data in bytes, @n * else @c -1 if an exception occurs - * @param[in] columnIndex The index of the destination column + * @param[in] columnIndex The column index * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @remarks The method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n - * If the destination column is of type %String, this method returns the @c byte length excluding the @c null terminator character. @n - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - This method must be called after MoveNext(), MoveFirst(), or MoveLast(). + * - If the destination column is of type String, this method returns the @c byte length excluding the @c null terminator character. + * - The specific error code can be accessed using the GetLastResult() method. */ virtual int GetColumnSize(int columnIndex) const = 0;