Merge master to 2.1 branch
authorJaehwa Shin <jaehwa.shin@samsung.com>
Fri, 15 Mar 2013 10:45:25 +0000 (19:45 +0900)
committerJaehwa Shin <jaehwa.shin@samsung.com>
Tue, 19 Mar 2013 06:53:08 +0000 (15:53 +0900)
- Revised wrong doxygen descriptions
- Fixed the issue that E_STORAGE_FULL exception is not returned

Change-Id: Idfc7a04f848712fe97dde5fc6998bd961d828001

inc/FSclAddress.h
inc/FSclAddressbook.h
inc/FSclAddressbookManager.h
inc/FSclCategory.h
src/FScl_AddressbookImpl.cpp
src/FScl_AddressbookManagerImpl.cpp

index 7c39f9d..b71e893 100644 (file)
@@ -316,10 +316,9 @@ public:
         *                            For more information, see @ref CompAddressSetStreetPage "here".
         * @endif
         *
-        * @return              An error code
-        * @param[in]   street                  The new street value to set
-        * @exception   E_SUCCESS               The method is successful.
-        * @exception   E_INVALID_ARG   The specified @c street is an empty string.
+        * @return      An error code
+        * @param[in]   street          The new street value to set
+        * @exception   E_SUCCESS       The method is successful.
         */
        result SetStreet(const Tizen::Base::String& street);
 
@@ -350,7 +349,6 @@ public:
         * @return              An error code
         * @param[in]   city                    The new city value to set
         * @exception   E_SUCCESS               The method is successful.
-        * @exception   E_INVALID_ARG   The specified @c city is an empty string.
         */
        result SetCity(const Tizen::Base::String& city);
 
@@ -381,7 +379,6 @@ public:
         * @return              An error code
         * @param[in]   state                   The new state value to set
         * @exception   E_SUCCESS               The method is successful.
-        * @exception   E_INVALID_ARG   The specified @c state is an empty string.
         */
        result SetState(const Tizen::Base::String& state);
 
@@ -413,7 +410,6 @@ public:
         * @return              An error code
         * @param[in]   postalCode              The new postal code value to set
         * @exception   E_SUCCESS               The method is successful.
-        * @exception   E_INVALID_ARG   The specified @c postalCode is an empty string.
         */
        result SetPostalCode(const Tizen::Base::String& postalCode);
 
@@ -445,7 +441,6 @@ public:
         * @return              An error code
         * @param[in]   country                 The new country value to set
         * @exception   E_SUCCESS               The method is successful.
-        * @exception   E_INVALID_ARG   The specified @c country is an empty string.
         */
        result SetCountry(const Tizen::Base::String& country);
 
@@ -476,7 +471,6 @@ public:
         * @return              An error code
         * @param[in]   postOfficeBoxNumber             The new post office box number value to set
         * @exception   E_SUCCESS                       The method is successful.
-        * @exception   E_INVALID_ARG                   The specified @c postOfficeBoxNumber is an empty string.
         */
        result SetPostOfficeBoxNumber(const Tizen::Base::String& postOfficeBoxNumber);
 
index 90b0de5..5f189ba 100644 (file)
@@ -358,9 +358,9 @@ public:
         * @param[in,out]       contact                 The contact to add
         * @exception   E_SUCCESS               The method is successful.
         * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
-        * @exception   E_STORAGE_FULL          The capacity of this address book is full.
         * @exception   E_INVALID_ARG           The contact ID is not #INVALID_RECORD_ID, or
         *                                                                      the properties of the contact have not been set.
+        * @exception   E_STORAGE_FULL          The storage is insufficient.
         * @exception   E_SYSTEM                A system error has occurred.
         * @remarks   The #CONTACT_PROPERTY_ID_DISPLAY_NAME and #CONTACT_PROPERTY_ID_LAST_REVISION properties cannot be set.
         * @n #CONTACT_PROPERTY_ID_DISPLAY_NAME is automatically generated from the first name and last name.
@@ -416,8 +416,8 @@ public:
         * @exception   E_SUCCESS               The method is successful.
         * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
         * @exception   E_OBJ_NOT_FOUND         The specified @c contact does not exist in this address book.
-        * @exception   E_INVALID_ARG           The specified @c contact is invalid, or
-        *                                                                      the properties of the specified @c contact have not been set.
+        * @exception   E_INVALID_ARG           The specified @c contact is invalid or the properties of the specified @c contact have not been set.
+        * @exception   E_STORAGE_FULL          The storage is insufficient.
         * @exception   E_SYSTEM                A system error has occurred.
         */
        result UpdateContact(const Contact& contact);
@@ -445,7 +445,7 @@ public:
         *                                                                      - The name of the category has not been set. @n
         *                                                                      - The category ID of the @c category is not #INVALID_RECORD_ID. @n
         *                                                                      - One of the contact members is invalid.
-        * @exception   E_STORAGE_FULL          The capacity of this address book is full.
+        * @exception   E_STORAGE_FULL          The storage is insufficient.
         * @exception   E_SYSTEM                A system error has occurred.
         */
        result AddCategory(Category& category);
@@ -521,6 +521,7 @@ public:
         * @exception   E_OBJ_NOT_FOUND         The specified @c category does not exist in this address book.
         * @exception   E_INVALID_ARG           The specified @c category is invalid, or
         *                                                                      one of the contact members is invalid.
+        * @exception   E_STORAGE_FULL          The storage is insufficient.
         * @exception   E_SYSTEM                A system error has occurred.
         */
        result UpdateCategory(const Category& category);
index a3e62f7..fd17fc3 100644 (file)
@@ -65,7 +65,9 @@ class _OSP_EXPORT_ AddressbookManager
 {
 public:
        /**
-        * Creates an addressbook with the specified account ID and name.
+        * Creates an addressbook with the specified account ID and name. @n
+        * The accountId must specify a valid account and only one addressbook can be created per a account. @n
+        * The name of the addressbook must be specified and the name must be unique among the addressbooks on the device.
         *
         * @since       2.0
         * @privlevel   public
@@ -76,8 +78,9 @@ public:
         * @param[in]   name            The addressbook name
         * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
-        * @exception   E_INVALID_ARG       The specified @c accountId is invalid.
-        * @exception   E_OBJ_ALREADY_EXIST The addressbook with the specified account ID and name already exists.
+        * @exception   E_INVALID_ARG       The specified @c accountId is invalid or @c name is an empty string.
+        * @exception   E_OBJ_ALREADY_EXIST The addressbook with the specified account ID or name already exists.
+        * @exception   E_STORAGE_FULL          The storage is insufficient.
         * @exception   E_SYSTEM                        A system error has occurred.
         * @remarks             The specific error code can be accessed using the GetLastResult() method.
         */
@@ -211,7 +214,8 @@ public:
         *                                                                      - The properties of the contact have not been set. @n
         *                                                                      - The specified @c addressbookId is invalid.
         * @exception   E_OBJ_NOT_FOUND         The specified addressbook is not found.
-        * @exception   E_SYSTEM                        A system error has occurred.
+        * @exception   E_STORAGE_FULL          The storage is insufficient.
+        * @exception   E_SYSTEM                A system error has occurred.
         * @remarks     The #CONTACT_PROPERTY_ID_DISPLAY_NAME and #CONTACT_PROPERTY_ID_LAST_REVISION
         * properties cannot be set. @n #CONTACT_PROPERTY_ID_DISPLAY_NAME is automatically generated from the first name and
         * the last name. And #CONTACT_PROPERTY_ID_LAST_REVISION is automatically updated with the last update time.
@@ -250,6 +254,7 @@ public:
         * @exception   E_OBJ_NOT_FOUND     The specified @c contact does not exist in this address book.
         * @exception   E_INVALID_ARG           The specified @c contact is invalid, or
         *                                                                      the properties of the specified @c contact have not been set.
+        * @exception   E_STORAGE_FULL          The storage is insufficient.
         * @exception   E_SYSTEM                        A system error has occurred.
         */
        result UpdateContact(const Contact& contact);
@@ -273,7 +278,7 @@ public:
         *                                                                      - One of the member contacts is invalid. @n
         *                                                                      - The category ID of the @c category is not #INVALID_RECORD_ID. @n
         *                                                                      - The specified @c addressbookId is invalid.
-        * @exception   E_STORAGE_FULL          The capacity of this address book is full.
+        * @exception   E_STORAGE_FULL          The storage is insufficient.
         * @exception   E_SYSTEM                A system error has occurred.
         */
        result AddCategory(Category& category, AddressbookId addressbookId);
@@ -310,6 +315,7 @@ public:
         * @exception   E_OBJ_NOT_FOUND     The specified @c category does not exist in this address book.
         * @exception   E_INVALID_ARG           The specified @c category is invalid, or
         *                                                                      one of the contact members is invalid.
+        * @exception   E_STORAGE_FULL          The storage is insufficient.
         * @exception   E_SYSTEM                        A system error has occurred.
         */
        result UpdateCategory(const Category& category);
@@ -1023,7 +1029,7 @@ public:
         * @exception   E_INVALID_ARG           The specified @c person is invalid.
         * @exception   E_ILLEGAL_ACCESS        Access is denied due to insufficient permission.
         * @exception   E_FILE_ALREADY_EXIST    The specified file already exists.
-        * @exception   E_STORAGE_FULL          The disk space is full.
+        * @exception   E_STORAGE_FULL          The storage is insufficient.
         * @exception   E_SYSTEM                The method cannot proceed due to a severe system error.
         */
        result ExportPersonToVcard(const Person& person, const Tizen::Base::String& vcardPath);
@@ -1044,7 +1050,7 @@ public:
         *                                      the specified @c vcardPath is invalid.
         * @exception   E_ILLEGAL_ACCESS        Access is denied due to insufficient permission.
         * @exception   E_FILE_ALREADY_EXIST    The specified file already exists.
-        * @exception   E_STORAGE_FULL          The disk space is full.
+        * @exception   E_STORAGE_FULL          The storage is insufficient.
         * @exception   E_SYSTEM                The method cannot proceed due to a severe system error.
         */
        result ExportPersonsToVcard(const Tizen::Base::Collection::IList& personList, const Tizen::Base::String& vcardPath);
@@ -1061,7 +1067,7 @@ public:
         * @exception   E_INVALID_ARG           The specified @c contact is invalid.
         * @exception   E_ILLEGAL_ACCESS        Access is denied due to insufficient permission.
         * @exception   E_FILE_ALREADY_EXIST    The specified file already exists.
-        * @exception   E_STORAGE_FULL          The disk space is full.
+        * @exception   E_STORAGE_FULL          The storage is insufficient.
         * @exception   E_SYSTEM                The method cannot proceed due to a severe system error.
         */
        result ExportContactToVcard(const Contact& contact, const Tizen::Base::String& vcardPath);
@@ -1079,7 +1085,7 @@ public:
         *                                      the specified @c vcardPath is invalid.
         * @exception   E_ILLEGAL_ACCESS        Access is denied due to insufficient permission.
         * @exception   E_FILE_ALREADY_EXIST    The specified file already exists.
-        * @exception   E_STORAGE_FULL          The disk space is full.
+        * @exception   E_STORAGE_FULL          The storage is insufficient.
         * @exception   E_SYSTEM                The method cannot proceed due to a severe system error.
         */
        result ExportContactsToVcard(const Tizen::Base::Collection::IList& contactList, const Tizen::Base::String& vcardPath);
@@ -1213,7 +1219,7 @@ public:
         * @exception   E_INVALID_ARG           The specified @c userProfile is invalid.
         * @exception   E_ILLEGAL_ACCESS        Access is denied due to insufficient permission.
         * @exception   E_FILE_ALREADY_EXIST    The specified file already exists.
-        * @exception   E_STORAGE_FULL          The disk space is full.
+        * @exception   E_STORAGE_FULL          The storage is insufficient.
         * @exception   E_SYSTEM                The method cannot proceed due to a severe system error.
         */
        result ExportUserProfileToVcard(const UserProfile& userProfile, const Tizen::Base::String& vcardPath);
@@ -1231,7 +1237,7 @@ public:
         *                                      the specified @c vcardPath is invalid.
         * @exception   E_ILLEGAL_ACCESS        Access is denied due to insufficient permission.
         * @exception   E_FILE_ALREADY_EXIST    The specified file already exists.
-        * @exception   E_STORAGE_FULL          The disk space is full.
+        * @exception   E_STORAGE_FULL          The storage is insufficient.
         * @exception   E_SYSTEM                The method cannot proceed due to a severe system error.
         */
        result ExportUserProfilesToVcard(const Tizen::Base::Collection::IList& userProfileList, const Tizen::Base::String& vcardPath);
index 8a3dd05..21c5429 100644 (file)
@@ -220,7 +220,7 @@ public:
         * @return      An error code
         * @param [in]  filePath                The file path of the ringtone
         * @exception   E_SUCCESS               The method is successful.
-        * @exception   E_INVALID_ARG           The specified @c filePath is an empty string.
+        * @exception   E_INVALID_ARG           The length of the specified @c filePath exceeds system limitations.
         * @exception   E_FILE_NOT_FOUND        The specified file cannot be found or accessed.
         * @see GetRingtonePath()
         */
index 3a60adc..f616aa8 100644 (file)
@@ -308,6 +308,7 @@ _AddressbookImpl::AddContact(Contact& contact)
 
        int ret = contacts_db_insert_record(recordHandle, &recordId);
        SysTryReturn(NID_SCL, ret != CONTACTS_ERROR_OUT_OF_MEMORY, E_OUT_OF_MEMORY, E_OUT_OF_MEMORY, "[%s] Memory allocation failed.", GetErrorMessage(E_OUT_OF_MEMORY));
+       SysTryReturn(NID_SCL, ret != CONTACTS_ERROR_FILE_NO_SPACE, E_STORAGE_FULL, E_STORAGE_FULL, "[%s] The storage is insufficient.", GetErrorMessage(E_STORAGE_FULL));
        SysTryReturn(NID_SCL, ret == CONTACTS_ERROR_NONE, E_SYSTEM, E_SYSTEM, "[%s] A system error has been occurred.", GetErrorMessage(E_SYSTEM));
 
        ret = contacts_db_get_record(_contacts_contact._uri, recordId, &recordHandle);
@@ -361,6 +362,7 @@ _AddressbookImpl::AddCategory(Category& category)
 
        int ret = contacts_db_insert_record(recordHandle, &recordId);
        SysTryReturn(NID_SCL, ret != CONTACTS_ERROR_OUT_OF_MEMORY, E_OUT_OF_MEMORY, E_OUT_OF_MEMORY, "[%s] Memory allocation failed.", GetErrorMessage(E_OUT_OF_MEMORY));
+       SysTryReturn(NID_SCL, ret != CONTACTS_ERROR_FILE_NO_SPACE, E_STORAGE_FULL, E_STORAGE_FULL, "[%s] The storage is insufficient.", GetErrorMessage(E_STORAGE_FULL));
        SysTryReturn(NID_SCL, ret == CONTACTS_ERROR_NONE, E_SYSTEM, E_SYSTEM, "[%s] A system error has been occurred.", GetErrorMessage(E_SYSTEM));
 
        ret = contacts_db_get_record(_contacts_group._uri, recordId, &recordHandle);
@@ -492,6 +494,7 @@ _AddressbookImpl::UpdateContact(const Contact& contact)
        ret = contacts_db_update_record(recordHandle);
        SysTryReturn(NID_SCL, ret != CONTACTS_ERROR_NO_DATA, E_OBJ_NOT_FOUND, E_OBJ_NOT_FOUND, "[%s] The contact is not found.", GetErrorMessage(E_OBJ_NOT_FOUND));
        SysTryReturn(NID_SCL, ret != CONTACTS_ERROR_OUT_OF_MEMORY, E_OUT_OF_MEMORY, E_OUT_OF_MEMORY, "[%s] Memory allocation failed.", GetErrorMessage(E_OUT_OF_MEMORY));
+       SysTryReturn(NID_SCL, ret != CONTACTS_ERROR_FILE_NO_SPACE, E_STORAGE_FULL, E_STORAGE_FULL, "[%s] The storage is insufficient.", GetErrorMessage(E_STORAGE_FULL));
        SysTryReturn(NID_SCL, ret == CONTACTS_ERROR_NONE, E_SYSTEM, E_SYSTEM, "[%s] A system error has been occurred.", GetErrorMessage(E_SYSTEM));
 
        ret = contacts_db_get_record(_contacts_contact._uri, contact.GetRecordId(), &recordHandle);
@@ -564,6 +567,7 @@ _AddressbookImpl::UpdateCategory(const Category& category)
        ret = contacts_db_update_record(recordHandle);
        SysTryReturn(NID_SCL, ret != CONTACTS_ERROR_NO_DATA, E_OBJ_NOT_FOUND, E_OBJ_NOT_FOUND, "[%s] The contact is not found.", GetErrorMessage(E_OBJ_NOT_FOUND));
        SysTryReturn(NID_SCL, ret != CONTACTS_ERROR_OUT_OF_MEMORY, E_OUT_OF_MEMORY, E_OUT_OF_MEMORY, "[%s] Memory allocation failed.", GetErrorMessage(E_OUT_OF_MEMORY));
+       SysTryReturn(NID_SCL, ret != CONTACTS_ERROR_FILE_NO_SPACE, E_STORAGE_FULL, E_STORAGE_FULL, "[%s] The storage is insufficient.", GetErrorMessage(E_STORAGE_FULL));
        SysTryReturn(NID_SCL, ret == CONTACTS_ERROR_NONE, E_SYSTEM, E_SYSTEM, "[%s] A system error has been occurred.", GetErrorMessage(E_SYSTEM));
 
        ret = contacts_db_get_record(_contacts_group._uri, category.GetRecordId(), &recordHandle);
index de2b5f1..bb63aa6 100644 (file)
@@ -362,6 +362,7 @@ _AddressbookManagerImpl::AddContact(Contact& contact, AddressbookId addressbookI
 
        ret = contacts_db_insert_record(recordHandle, &recordId);
        SysTryReturn(NID_SCL, ret != CONTACTS_ERROR_OUT_OF_MEMORY, E_OUT_OF_MEMORY, E_OUT_OF_MEMORY, "[%s] Memory allocation failed.", GetErrorMessage(E_OUT_OF_MEMORY));
+       SysTryReturn(NID_SCL, ret != CONTACTS_ERROR_FILE_NO_SPACE, E_STORAGE_FULL, E_STORAGE_FULL, "[%s] The storage is insufficient.", GetErrorMessage(E_STORAGE_FULL));
        SysTryReturn(NID_SCL, ret == CONTACTS_ERROR_NONE, E_SYSTEM, E_SYSTEM, "[%s] A system error has been occurred.", GetErrorMessage(E_SYSTEM));
 
        ret = contacts_db_get_record(_contacts_contact._uri, recordId, &recordHandle);
@@ -392,6 +393,7 @@ _AddressbookManagerImpl::AddCategory(Category& category, AddressbookId addressbo
 
        int ret = contacts_db_insert_record(recordHandle, &recordId);
        SysTryReturn(NID_SCL, ret != CONTACTS_ERROR_OUT_OF_MEMORY, E_OUT_OF_MEMORY, E_OUT_OF_MEMORY, "[%s] Memory allocation failed.", GetErrorMessage(E_OUT_OF_MEMORY));
+       SysTryReturn(NID_SCL, ret != CONTACTS_ERROR_FILE_NO_SPACE, E_STORAGE_FULL, E_STORAGE_FULL, "[%s] The storage is insufficient.", GetErrorMessage(E_STORAGE_FULL));
        SysTryReturn(NID_SCL, ret == CONTACTS_ERROR_NONE, E_SYSTEM, E_SYSTEM, "[%s] A system error has been occurred.", GetErrorMessage(E_SYSTEM));
 
        ret = contacts_db_get_record(_contacts_group._uri, recordId, &recordHandle);
@@ -506,6 +508,7 @@ _AddressbookManagerImpl::UpdateContact(const Contact& contact)
 
        ret = contacts_db_update_record(recordHandle);
        SysTryReturn(NID_SCL, ret != CONTACTS_ERROR_OUT_OF_MEMORY, E_OUT_OF_MEMORY, E_OUT_OF_MEMORY, "[%s] Memory allocation failed.", GetErrorMessage(E_OUT_OF_MEMORY));
+       SysTryReturn(NID_SCL, ret != CONTACTS_ERROR_FILE_NO_SPACE, E_STORAGE_FULL, E_STORAGE_FULL, "[%s] The storage is insufficient.", GetErrorMessage(E_STORAGE_FULL));
        SysTryReturn(NID_SCL, ret == CONTACTS_ERROR_NONE, E_SYSTEM, E_SYSTEM, "[%s] A system error has been occurred. Failed to update a contact.", GetErrorMessage(E_SYSTEM));
 
        ret = contacts_db_get_record(_contacts_contact._uri, contact.GetRecordId(), &recordHandle);
@@ -542,6 +545,7 @@ _AddressbookManagerImpl::UpdateCategory(const Category& category)
 
        ret = contacts_db_update_record(recordHandle);
        SysTryReturn(NID_SCL, ret != CONTACTS_ERROR_OUT_OF_MEMORY, E_OUT_OF_MEMORY, E_OUT_OF_MEMORY, "[%s] Memory allocation failed.", GetErrorMessage(E_OUT_OF_MEMORY));
+       SysTryReturn(NID_SCL, ret != CONTACTS_ERROR_FILE_NO_SPACE, E_STORAGE_FULL, E_STORAGE_FULL, "[%s] The storage is insufficient.", GetErrorMessage(E_STORAGE_FULL));
        SysTryReturn(NID_SCL, ret == CONTACTS_ERROR_NONE, E_SYSTEM, E_SYSTEM, "[%s] A system error has been occurred.", GetErrorMessage(E_SYSTEM));
 
        ret = contacts_db_get_record(_contacts_group._uri, category.GetRecordId(), &recordHandle);