Class PermissionDAO

Hierarchy (View Summary)

BaseDAO
- PermissionDAO

Implements

IPermissionsDAO

Index

Constructors

Properties

Methods

createPermission deletePermissionById deletePermissionByName executeQuery executeQueryMultiple getAllPermissions getPermissionById getPermissionByName mapCacheError mapError mapPostgresError scalar

Constructors

constructor

new PermissionDAO(dbClient: IDbClient): PermissionDAO
Protected constructor to enforce singleton usage via getInstance.
Parameters
- dbClient: IDbClient
Returns PermissionDAO
Overrides BaseDAO.constructor
- Defined in src/dao/db/PermissionDAO.ts:18

Properties

`Protected` `Readonly`db

Methods

createPermission

createPermission(permissionName: string): Promise<Permission | null>
Create a new permission by name.

Calls the DB function Create_permission and returns the created Permission or null if not created.
Parameters
- permissionName: string
  Permission name (will be uppercased before call)
Returns Promise<Permission | null>
The created Permission or null
Implementation of IPermissionsDAO.createPermission
- Defined in src/dao/db/PermissionDAO.ts:30

deletePermissionById

deletePermissionById(permissionId: number): Promise<boolean>
Delete a permission by its numeric ID.

Calls the DB function Delete_permission_by_id and returns boolean result.
Parameters
- permissionId: number
  Numeric ID of the permission to delete
Returns Promise<boolean>
true when deleted, false otherwise
Implementation of IPermissionsDAO.deletePermissionById
- Defined in src/dao/db/PermissionDAO.ts:45

deletePermissionByName

deletePermissionByName(permissionName: string): Promise<boolean>
f Delete a permission by its name.

The name will be uppercased before invoking the DB function.
Parameters
- permissionName: string
  Name of the permission to delete
Returns Promise<boolean>
true when deleted, false otherwise
Implementation of IPermissionsDAO.deletePermissionByName
- Defined in src/dao/db/PermissionDAO.ts:63

`Protected`executeQuery

executeQuery<T>(query: string, params?: any[]): Promise<T | null>
Type Parameters
- T
Parameters
- query: string
- Optionalparams: any[]
Returns Promise<T | null>
Inherited from BaseDAO.executeQuery
- Defined in src/dao/db/BaseDao.ts:83

`Protected`executeQueryMultiple

executeQueryMultiple<T>(query: string, params?: any[]): Promise<T[]>
Type Parameters
- T
Parameters
- query: string
- Optionalparams: any[]
Returns Promise<T[]>
Inherited from BaseDAO.executeQueryMultiple
- Defined in src/dao/db/BaseDao.ts:97

getAllPermissions

getAllPermissions(): Promise<Permission[] | null>
Retrieve all permissions.

Returns Promise<Permission[] | null>
Array of Permission or null if none
Implementation of IPermissionsDAO.getAllPermissions
- Defined in src/dao/db/PermissionDAO.ts:78

getPermissionById

getPermissionById(permissionId: number): Promise<Permission | null>
Get permission by its ID.
Parameters
- permissionId: number
  Numeric ID of the permission
Returns Promise<Permission | null>
Permission or null if not found
Implementation of IPermissionsDAO.getPermissionById
- Defined in src/dao/db/PermissionDAO.ts:106

getPermissionByName

getPermissionByName(permissionName: string): Promise<Permission | null>
Get permission by its name.
Parameters
- permissionName: string
  Name of the permission to look up
Returns Promise<Permission | null>
Permission or null if not found
Implementation of IPermissionsDAO.getPermissionByName
- Defined in src/dao/db/PermissionDAO.ts:91

`Protected`mapCacheError

mapCacheError(error: any): DaoError
Parameters
- error: any
Returns DaoError
Inherited from BaseDAO.mapCacheError
- Defined in src/dao/db/BaseDao.ts:47

`Protected`mapError

mapError(error: any): DaoError
Parameters
- error: any
Returns DaoError
Inherited from BaseDAO.mapError
- Defined in src/dao/db/BaseDao.ts:60

`Protected`mapPostgresError

mapPostgresError(error: any): DaoError
Parameters
- error: any
Returns DaoError
Inherited from BaseDAO.mapPostgresError
- Defined in src/dao/db/BaseDao.ts:16

`Protected`scalar

scalar<T = any>(query: string, params?: any[]): Promise<T>
Type Parameters
- T = any
Parameters
- query: string
- Optionalparams: any[]
Returns Promise<T>
Inherited from BaseDAO.scalar
- Defined in src/dao/db/BaseDao.ts:109