Fix comments in privilege_db.h regarding exceptions thrown by functions

Change DB::SqlConnection::Exception::* to PrivilegeDb::Exception::*

Change-Id: I7e42d9b97f1a7e517757a8cd205c64f7b68ec9b6
Signed-off-by: Radoslaw Bartosiak <r.bartosiak@samsung.com>

diff --git a/src/common/include/privilege_db.h b/src/common/include/privilege_db.h
index 827ab21c901b68bc15acce992da544b3455dc776..384c9577d82730ebb649513c093a59eab3256ea8 100644 (file)
--- a/src/common/include/privilege_db.h
+++ b/src/common/include/privilege_db.h
@@ -172,7 +172,7 @@ public:
     ~PrivilegeDb(void);
     /**
      * Constructor
-     * @exception DB::SqlConnection::Exception::IOError on problems with database access
+     * @exception PrivilegeDb::Exception::IOError on problems with database access
      *
      */
     PrivilegeDb(const std::string &path = std::string(PRIVILEGE_DB_PATH));
@@ -181,21 +181,21 @@ public:
 
     /**
      * Begin transaction
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::InternalError on internal error
      *
      */
     void BeginTransaction(void);
 
     /**
      * Commit transaction
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::InternalError on internal error
      *
      */
     void CommitTransaction(void);
 
     /**
      * Rollback transaction
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::InternalError on internal error
      *
      */
     void RollbackTransaction(void);
@@ -204,8 +204,8 @@ public:
      * Check if appName is registered in database
      *
      * @param appName - package identifier
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      *
      */
     bool AppNameExists(const std::string &appName);
@@ -214,8 +214,8 @@ public:
      * Check if pkgName is already registered in database
      *
      * @param pkgName - package identifier
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      * @return true if pkgName exists in the database
      *
      */
@@ -225,8 +225,8 @@ public:
      * Check if authorId is already registered in database
      *
      * @param authorId numerical author identifier
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      * @return true if authorId exists in the database
      *
      */
@@ -237,8 +237,8 @@ public:
      *
      * @param appName - application identifier
      * @param[out] pkgName - return application's package identifier
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      */
     void GetAppPkgName(const std::string &appName, std::string &pkgName);
 
@@ -247,8 +247,8 @@ public:
      *
      * @param appName - application identifier
      * @param[out] tizenVer - return application's target Tizen version
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      */
     void GetAppVersion(const std::string &appName, std::string &tizenVer);
 
@@ -261,8 +261,8 @@ public:
      * @param targetTizenVer - target tizen version for application
      * @param author - author identifier
      * @param isHybrid - hybrid flag setting
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      */
     void AddApplication(
             const std::string &appName,
@@ -280,8 +280,8 @@ public:
      * @param[out] appNameIsNoMore - return info if appName is in the database
      * @param[out] pkgNameIsNoMore - return info if pkgName is in the database
      * @param[out] authorNameIsNoMore - return info if authorName is in the database
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      */
     void RemoveApplication(
             const std::string &appName,
@@ -295,8 +295,8 @@ public:
      *
      * @param path - path name
      * @param[out] count - count of sharing
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      */
     void GetPathSharingCount(const std::string &path, int &count);
 
@@ -306,8 +306,8 @@ public:
      * @param ownerAppName - application identifier
      * @param targetAppName - application identifier
      * @param[out] count - count of sharing
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      */
     void GetOwnerTargetSharingCount(const std::string &ownerAppName, const std::string &targetAppName,
                                     int &count);
@@ -318,8 +318,8 @@ public:
      * @param targetAppName - application identifier
      * @param path - user identifier for whom privileges will be updated
      * @param[out] count - count of sharing
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      */
     void GetTargetPathSharingCount(const std::string &targetAppName,
                                    const std::string &path,
@@ -332,8 +332,8 @@ public:
      * @param targetAppName - application identifier
      * @param path - path name
      * @param pathLabel - label of path
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      */
     void ApplyPrivateSharing(const std::string &ownerAppName, const std::string &targetAppName,
                              const std::string &path, const std::string &pathLabel);
@@ -344,8 +344,8 @@ public:
      * @param ownerAppName - application identifier
      * @param targetAppName - application identifier
      * @param path - path name
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      */
     void DropPrivateSharing(const std::string &ownerAppName, const std::string &targetAppName,
                             const std::string &path);
@@ -354,8 +354,8 @@ public:
      * Get all shared paths mapped to application names
      *
      * @param appPathMap - map containing vectors of paths shared by applications mapped by name
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      */
     void GetAllPrivateSharing(std::map<std::string, std::vector<std::string>> &appPathMap);
 
@@ -365,7 +365,7 @@ public:
      * @param ownerAppName - owner of queried sharings
      * @param ownerSharing - map containing vectors of paths shared by specified application
      *                     mapped by target application names
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::InternalError on internal error
      */
     void GetPrivateSharingForOwner(const std::string &ownerAppName,
                                    std::map<std::string, std::vector<std::string>> &ownerSharing);
@@ -375,7 +375,7 @@ public:
      * @param targetAppName - target of queried sharings
      * @param targetSharing - map containing vectors of paths shared with specified application
      *                     mapped by owner application names
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::InternalError on internal error
      */
     void GetPrivateSharingForTarget(const std::string &targetAppName,
                                     std::map<std::string, std::vector<std::string>> &targetSharing);
@@ -386,15 +386,15 @@ public:
      * @param targetAppName - target application name
      * @param path - path name
      *
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::InternalError on internal error
      */
     void SquashSharing(const std::string &targetAppName, const std::string &path);
 
     /**
      * Clear information about private sharing.
      *
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      */
     void ClearPrivateSharing();
 
@@ -403,8 +403,8 @@ public:
      *
      * @param privilege - privilege identifier
      * @param[out] grp_names - list of group names assigned to the privilege
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      */
     void GetPrivilegeGroups(const std::string &privilege,
         std::vector<std::string> &grp_names);
@@ -416,8 +416,8 @@ public:
      * @param[out] apps - list of apps assigned to user,
      *                    this parameter do not need to be empty, but
      *                    it is being overwritten during function call.
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      */
     void GetUserApps(uid_t uid, std::vector<std::string> &apps);
 
@@ -428,8 +428,8 @@ public:
      * @param[out] pkgs - list of packages assigned to user,
      *                    this parameter do not need to be empty, but
      *                    it is being overwritten during function call.
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      */
     void GetUserPkgs(uid_t uid, std::vector<std::string> &pkgs);
 
@@ -438,8 +438,8 @@ public:
      *
      * @param pkgName - package identifier
      * @param[out] appNames - list of application identifiers for the package
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      */
     void GetPkgApps(const std::string &pkgName, std::vector<std::string> &appNames);
 
@@ -449,8 +449,8 @@ public:
      * @param[out] packages - vector of package identifiers describing installed packages,
      *                        this parameter do not need to be empty, but
      *                        it is being overwritten during function call.
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      */
     void GetAllPackages(std::vector<std::string> &packages);
 
@@ -459,8 +459,8 @@ public:
      * @param pkgName[in] package identifier
      * @param authorId[out] author id associated with the package, or -1 if no
      *                      author was assigned during installation
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      */
     void GetPkgAuthorId(const std::string &pkgName, int &authorId);
 
@@ -469,8 +469,8 @@ public:
      * @param[in] authorName    author's name
      * @param[out] authorId     matching author id or -1 if no such author exists
      *
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      */
     void GetAuthorIdByName(const std::string &authorName, int &authorId);
 
@@ -478,8 +478,8 @@ public:
      * Retrieve list of resource groups
      *
      * @param[out] grp_names - list of group names
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      */
     void GetGroups(std::vector<std::string> &grp_names);
 
@@ -487,32 +487,32 @@ public:
      * Retrieve vector of pairs with group_name (1st value) and privilege_name (2nd value)
      *
      * @param[out] privileges - list of privileges
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      */
     void GetGroupsRelatedPrivileges(std::vector<std::pair<std::string, std::string>> &privileges);
 
     /**
      * Set shared_ro field to 1 in package given by name
      *
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      */
     void SetSharedROPackage(const std::string& pkgName);
 
     /**
      * Check whether package has shared_ro field set to 1 in db
      *
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      */
     bool IsPackageSharedRO(const std::string& pkgName);
 
     /**
      * Check whether package has is_hybrid field set to 1 in db
      *
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      */
     bool IsPackageHybrid(const std::string& pkgName);
 
@@ -523,8 +523,8 @@ public:
      *                        this parameter do not need to be empty, but
      *                        it is being overwritten during function call.
      *
-     * @exception DB::SqlConnection::Exception::InternalError on internal error
-     * @exception DB::SqlConnection::Exception::ConstraintError on constraint violation
+     * @exception PrivilegeDb::Exception::InternalError on internal error
+     * @exception PrivilegeDb::Exception::ConstraintError on constraint violation
      */
     void GetPackagesInfo(std::vector<PkgInfo> &packages);
 };