OpenPRA Documentation

backends-web-backend

Class: ScWorkbooksService ​

Defined in: backends/web-backend/src/sc-workbooks/sc-workbooks.service.ts:42

Constructors ​

Constructor ​

new ScWorkbooksService(scWorkbookModel, signoffModel, projectsService, exampleWorkbooksService, rolesService, scDocumentsService): ScWorkbooksService

Defined in: backends/web-backend/src/sc-workbooks/sc-workbooks.service.ts:43

Parameters ​

scWorkbookModel ​

Model<ScWorkbookDocument>

signoffModel ​

Model<WorkbookSignoffDocument>

projectsService ​

ProjectsService

exampleWorkbooksService ​

ExampleWorkbooksService

rolesService ​

WorkbookRolesService

scDocumentsService ​

ScDocumentsService

Returns ​

ScWorkbooksService

Methods ​

findOne() ​

findOne(workbookId, acting): Promise<ScWorkbookResponse>

Defined in: backends/web-backend/src/sc-workbooks/sc-workbooks.service.ts:56

Parameters ​

workbookId ​

string

acting ​

ActingUser

Returns ​

Promise<ScWorkbookResponse>

loadExample() ​

loadExample(workbookId, acting, exampleId?): Promise<ScWorkbookResponse>

Defined in: backends/web-backend/src/sc-workbooks/sc-workbooks.service.ts:79

Parameters ​

workbookId ​

string

acting ​

ActingUser

exampleId? ​

string

Returns ​

Promise<ScWorkbookResponse>

replaceMef() ​

replaceMef(workbookId, mef, acting): Promise<ScWorkbookResponse>

Defined in: backends/web-backend/src/sc-workbooks/sc-workbooks.service.ts:64

Parameters ​

workbookId ​

string

mef ​

unknown

acting ​

ActingUser

Returns ​

Promise<ScWorkbookResponse>

unloadExample() ​

unloadExample(workbookId, acting): Promise<ScWorkbookResponse>

Defined in: backends/web-backend/src/sc-workbooks/sc-workbooks.service.ts:105

Parameters ​

workbookId ​

string

acting ​

ActingUser

Returns ​

Promise<ScWorkbookResponse>