Class RolesService<RoleType>

An implementation of the FIN Roles service.

Type Parameters

RoleType extends Role = Role

Index

Constructors

Methods

create createRole deleteById readAll readByFilter readById update

Constructors

constructor

new RolesService<RoleType extends Role = Role>(
serviceConfig: ClientServiceConfig,
): RolesService<RoleType>
Constructs a new roles service object.
Type Parameters
- RoleType extends Role = Role
Parameters
- serviceConfig: ClientServiceConfig
  Service configuration.
Returns RolesService<RoleType>
- Defined in src/client/roles/RolesService.ts:44

Methods

create

create(
roles: HaysonDict[] | RoleType[] | HGrid<RoleType>,
): Promise<HGrid<RoleType>>
Create multiple role records.
Parameters
- roles: HaysonDict[] | RoleType[] | HGrid<RoleType>
Returns Promise<HGrid<RoleType>>
A grid of roles.
- Defined in src/client/roles/RolesService.ts:121

createRole

createRole(role: HaysonDict | RoleType): Promise<RoleType>
Create a single role record.
Parameters
- role: HaysonDict | RoleType
  The role record to create.
Returns Promise<RoleType>
The created role record.
- Defined in src/client/roles/RolesService.ts:141

deleteById

deleteById(id: string | HRef): Promise<void>
Delete a role record via its id.
Parameters
- id: string | HRef
  The id of the record to delete.
Returns Promise<void>
- Defined in src/client/roles/RolesService.ts:179

readAll

readAll(options?: RolesReadOptions): Promise<RoleType[]>
Query all roles.
Parameters
- Optionaloptions: RolesReadOptions
  Optional options for read operation.
Returns Promise<RoleType[]>
The result of the read operation.
- Defined in src/client/roles/RolesService.ts:55

readByFilter

readByFilter(
filter: string,
options?: RolesReadOptions,
): Promise<HGrid<RoleType>>
Query some roles via a haystack filter.
Parameters
- filter: string
  The haystack filter to query by.
- Optionaloptions: RolesReadOptions
  Optional options for read operation.
Returns Promise<HGrid<RoleType>>
The result of the read operation.
- Defined in src/client/roles/RolesService.ts:99

readById

readById(id: string | HRef): Promise<RoleType>
Read a role via its id.
Parameters
- id: string | HRef
  The id of the role to read.
Returns Promise<RoleType>
The role record.

Throws
An error if the role can't be found.
- Defined in src/client/roles/RolesService.ts:80

update

update(role: HaysonDict | RoleType): Promise<RoleType>
Update a role record.
Parameters
- role: HaysonDict | RoleType
  The role record to update.
Returns Promise<RoleType>
A updated record. Please note, this record doesn't have any role information just the id and mod.
- Defined in src/client/roles/RolesService.ts:160