OpenPRA Documentation

backends-web-backend

Class: WorkbookWorkflowService ​

Defined in: backends/web-backend/src/workbooks/workbook-workflow.service.ts:48

Constructors ​

Constructor ​

new WorkbookWorkflowService(workbookModel, signoffModel, projectsService, rolesService, registry): WorkbookWorkflowService

Defined in: backends/web-backend/src/workbooks/workbook-workflow.service.ts:49

Parameters ​

workbookModel ​

Model<WorkbookDocument>

signoffModel ​

Model<WorkbookSignoffDocument>

projectsService ​

ProjectsService

rolesService ​

WorkbookRolesService

registry ​

WorkbookElementRegistry

Returns ​

WorkbookWorkflowService

Methods ​

awaitingMe() ​

awaitingMe(acting): Promise<object[]>

Defined in: backends/web-backend/src/workbooks/workbook-workflow.service.ts:243

Parameters ​

acting ​

ActingUser

Returns ​

Promise<object[]>

requestRevision() ​

requestRevision(workbookId, note, acting): Promise<unknown>

Defined in: backends/web-backend/src/workbooks/workbook-workflow.service.ts:231

Parameters ​

workbookId ​

string

note ​

string

acting ​

ActingUser

Returns ​

Promise<unknown>

signApproval() ​

signApproval(workbookId, acting, signatureDataUrl?): Promise<unknown>

Defined in: backends/web-backend/src/workbooks/workbook-workflow.service.ts:205

Parameters ​

workbookId ​

string

acting ​

ActingUser

signatureDataUrl? ​

string

Returns ​

Promise<unknown>

signAs() ​

signAs(workbookId, role, acting, signatureDataUrl?): Promise<unknown>

Defined in: backends/web-backend/src/workbooks/workbook-workflow.service.ts:164

Parameters ​

workbookId ​

string

role ​

WorkbookSignoffRole

acting ​

ActingUser

signatureDataUrl? ​

string

Returns ​

Promise<unknown>

signReview() ​

signReview(workbookId, acting, signatureDataUrl?): Promise<unknown>

Defined in: backends/web-backend/src/workbooks/workbook-workflow.service.ts:193

Parameters ​

workbookId ​

string

acting ​

ActingUser

signatureDataUrl? ​

string

Returns ​

Promise<unknown>

status() ​

status(workbookId, acting): Promise<WorkbookWorkflowStatus>

Defined in: backends/web-backend/src/workbooks/workbook-workflow.service.ts:91

Parameters ​

workbookId ​

string

acting ​

ActingUser

Returns ​

Promise<WorkbookWorkflowStatus>

submitForReview() ​

submitForReview(workbookId, acting): Promise<unknown>

Defined in: backends/web-backend/src/workbooks/workbook-workflow.service.ts:177

Parameters ​

workbookId ​

string

acting ​

ActingUser

Returns ​

Promise<unknown>

submitToApprover() ​

submitToApprover(workbookId, acting): Promise<unknown>

Defined in: backends/web-backend/src/workbooks/workbook-workflow.service.ts:217

Parameters ​

workbookId ​

string

acting ​

ActingUser

Returns ​

Promise<unknown>