OpenPRA Documentation

backends-web-backend

Class: SeismicPraMefAdapter ​

Defined in: backends/web-backend/src/seismic-pra-workbooks/seismic-pra-mef-adapter.ts:14

Implements ​

Constructors ​

Constructor ​

new SeismicPraMefAdapter(workbookModel, registry, workbooksService): SeismicPraMefAdapter

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

Parameters ​

workbookModel ​

Model<SeismicPraWorkbookDocument>

registry ​

WorkbookElementRegistry

workbooksService ​

SeismicPraWorkbooksService

Returns ​

SeismicPraMefAdapter

Properties ​

elementCode ​

readonly elementCode: "S" = "S"

Defined in: backends/web-backend/src/seismic-pra-workbooks/seismic-pra-mef-adapter.ts:15

Implementation of ​

WorkbookElementAdapter.elementCode

Methods ​

createBlank() ​

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

Defined in: backends/web-backend/src/seismic-pra-workbooks/seismic-pra-mef-adapter.ts:25

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/seismic-pra-workbooks/seismic-pra-mef-adapter.ts:50

Returns ​

WorkbookExampleVariant[]

Implementation of ​

WorkbookElementAdapter.exampleVariants

load() ​

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

Defined in: backends/web-backend/src/seismic-pra-workbooks/seismic-pra-mef-adapter.ts:29

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/seismic-pra-workbooks/seismic-pra-mef-adapter.ts:54

Parameters ​

workbookId ​

string

acting ​
username ​

string

exampleId ​

string

Returns ​

Promise<void>

Implementation of ​

WorkbookElementAdapter.loadExample

onModuleInit() ​

onModuleInit(): void

Defined in: backends/web-backend/src/seismic-pra-workbooks/seismic-pra-mef-adapter.ts:23

Returns ​

void

Implementation of ​

OnModuleInit.onModuleInit

save() ​

save(workbookId, mef): Promise<unknown>

Defined in: backends/web-backend/src/seismic-pra-workbooks/seismic-pra-mef-adapter.ts:34

Parameters ​

workbookId ​

string

mef ​

unknown

Returns ​

Promise<unknown>

Implementation of ​

WorkbookElementAdapter.save

validateForReview() ​

validateForReview(mef): string[]

Defined in: backends/web-backend/src/seismic-pra-workbooks/seismic-pra-mef-adapter.ts:44

Parameters ​

mef ​

object

Returns ​

string[]

Implementation of ​

WorkbookElementAdapter.validateForReview