OpenPRA Documentation

backends-web-backend

Class: SyWorkbooksService ​

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

Constructors ​

Constructor ​

new SyWorkbooksService(syWorkbookModel, signoffModel, projectsService, exampleWorkbooksService, rolesService, syDocumentsService): SyWorkbooksService

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

Parameters ​

syWorkbookModel ​

Model<SyWorkbookDocument>

signoffModel ​

Model<WorkbookSignoffDocument>

projectsService ​

ProjectsService

exampleWorkbooksService ​

ExampleWorkbooksService

rolesService ​

WorkbookRolesService

syDocumentsService ​

SyDocumentsService

Returns ​

SyWorkbooksService

Methods ​

findOne() ​

findOne(workbookId, acting): Promise<SyWorkbookResponse>

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

Parameters ​

workbookId ​

string

acting ​

ActingUser

Returns ​

Promise<SyWorkbookResponse>

loadExample() ​

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

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

Parameters ​

workbookId ​

string

acting ​

ActingUser

exampleId? ​

string

Returns ​

Promise<SyWorkbookResponse>

replaceMef() ​

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

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

Parameters ​

workbookId ​

string

mef ​

unknown

acting ​

ActingUser

Returns ​

Promise<SyWorkbookResponse>

unloadExample() ​

unloadExample(workbookId, acting): Promise<SyWorkbookResponse>

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

Parameters ​

workbookId ​

string

acting ​

ActingUser

Returns ​

Promise<SyWorkbookResponse>