OpenPRA Documentation

backends-web-backend

Class: RiMefAdapter ​

Defined in: backends/web-backend/src/ri-workbooks/ri-mef-adapter.ts:17

Implements ​

Constructors ​

Constructor ​

new RiMefAdapter(riWorkbookModel, registry, riWorkbooksService): RiMefAdapter

Defined in: backends/web-backend/src/ri-workbooks/ri-mef-adapter.ts:20

Parameters ​

riWorkbookModel ​

Model<RiWorkbookDocument>

registry ​

WorkbookElementRegistry

riWorkbooksService ​

RiWorkbooksService

Returns ​

RiMefAdapter

Properties ​

elementCode ​

readonly elementCode: "RI" = "RI"

Defined in: backends/web-backend/src/ri-workbooks/ri-mef-adapter.ts:18

Implementation of ​

WorkbookElementAdapter.elementCode

Methods ​

createBlank() ​

createBlank(workbookId, projectId, name, ownerUsername): Promise<void>

Defined in: backends/web-backend/src/ri-workbooks/ri-mef-adapter.ts:30

Parameters ​

workbookId ​

string

projectId ​

string

name ​

string

ownerUsername ​

string

Returns ​

Promise<void>

Implementation of ​

WorkbookElementAdapter.createBlank

exampleVariants() ​

exampleVariants(): WorkbookExampleVariant[]

Defined in: backends/web-backend/src/ri-workbooks/ri-mef-adapter.ts:51

Returns ​

WorkbookExampleVariant[]

Implementation of ​

WorkbookElementAdapter.exampleVariants

load() ​

load(workbookId): Promise<{ mef: unknown; ownerUsername: string; projectId: string; } | null>

Defined in: backends/web-backend/src/ri-workbooks/ri-mef-adapter.ts:35

Parameters ​

workbookId ​

string

Returns ​

Promise<{ mef: unknown; ownerUsername: string; projectId: string; } | null>

Implementation of ​

WorkbookElementAdapter.load

loadExample() ​

loadExample(workbookId, acting, exampleId): Promise<void>

Defined in: backends/web-backend/src/ri-workbooks/ri-mef-adapter.ts:59

Parameters ​

workbookId ​

string

acting ​
username ​

string

exampleId ​

string

Returns ​

Promise<void>

Implementation of ​

WorkbookElementAdapter.loadExample

onModuleInit() ​

onModuleInit(): void

Defined in: backends/web-backend/src/ri-workbooks/ri-mef-adapter.ts:26

Returns ​

void

Implementation of ​

OnModuleInit.onModuleInit

save() ​

save(workbookId, mef): Promise<unknown>

Defined in: backends/web-backend/src/ri-workbooks/ri-mef-adapter.ts:41

Parameters ​

workbookId ​

string

mef ​

unknown

Returns ​

Promise<unknown>

Implementation of ​

WorkbookElementAdapter.save