modelsdatastore

bpmn-server / ModelsDatastore

Class: ModelsDatastore

super class for various objects that are part of the server

Hierarchy

• ModelsDatastoreDB

  ↳ ModelsDatastore

Implements

• IModelsDatastore

Table of contents

Constructors

• constructor

Properties

• db
• dbConfiguration
• definitionsPath
• server

Accessors

• appDelegate
• cache
• configuration
• cron
• dataStore
• definitions
• engine
• listener
• logger

Methods

• deleteModel
• export
• findEvents
• getList
• getSVG
• getSource
• import
• install
• load
• loadModel
• rebuild
• renameModel
• save
• saveModel
• updateTimer

Constructors

constructor

• new ModelsDatastore(server): ModelsDatastore

Parameters

Name	Type
server	BPMNServer

Returns

ModelsDatastore

Overrides

ModelsDatastoreDB.constructor

Defined in

datastore/ModelsDatastore.ts:19

Properties

db

• db: any

Inherited from

ModelsDatastoreDB.db

Defined in

datastore/ModelsDatastoreDB.ts:25

---

dbConfiguration

• dbConfiguration: any

Inherited from

ModelsDatastoreDB.dbConfiguration

Defined in

datastore/ModelsDatastoreDB.ts:24

---

definitionsPath

• definitionsPath: any

Defined in

datastore/ModelsDatastore.ts:18

---

server

• server: any

Inherited from

ModelsDatastoreDB.server

Defined in

server/ServerComponent.ts:9

Accessors

appDelegate

• get appDelegate(): any

Returns

any

Inherited from

ModelsDatastoreDB.appDelegate

Defined in

server/ServerComponent.ts:18

---

cache

• get cache(): CacheManager

Returns

CacheManager

Inherited from

ModelsDatastoreDB.cache

Defined in

server/ServerComponent.ts:17

---

configuration

• get configuration(): any

Returns

any

Inherited from

ModelsDatastoreDB.configuration

Defined in

server/ServerComponent.ts:14

---

cron

• get cron(): Cron

Returns

Cron

Inherited from

ModelsDatastoreDB.cron

Defined in

server/ServerComponent.ts:16

---

dataStore

• get dataStore(): any

Returns

any

Inherited from

ModelsDatastoreDB.dataStore

Defined in

server/ServerComponent.ts:20

---

definitions

• get definitions(): any

Returns

any

Inherited from

ModelsDatastoreDB.definitions

Defined in

server/ServerComponent.ts:21

---

engine

• get engine(): IEngine

Returns

IEngine

Inherited from

ModelsDatastoreDB.engine

Defined in

server/ServerComponent.ts:19

---

listener

• get listener(): any

Returns

any

Inherited from

ModelsDatastoreDB.listener

Defined in

server/ServerComponent.ts:22

---

logger

• get logger(): any

Returns

any

Inherited from

ModelsDatastoreDB.logger

Defined in

server/ServerComponent.ts:15

Methods

deleteModel

▸ deleteModel(name, owner?): Promise<void>

Parameters

Name	Type	Default value
name	any	undefined
owner	any	null

Returns

Promise<void>

Implementation of

IModelsDatastore.deleteModel

Overrides

ModelsDatastoreDB.deleteModel

Defined in

datastore/ModelsDatastore.ts:100

---

export

▸ export(name, folderPath, owner?): Promise<void>

Parameters

Name	Type	Default value
name	any	undefined
folderPath	any	undefined
owner	any	null

Returns

Promise<void>

Inherited from

ModelsDatastoreDB.export

Defined in

datastore/ModelsDatastoreDB.ts:233

---

findEvents

▸ findEvents(query, owner?): Promise<IEventData[]>

Parameters

Name	Type	Default value
query	any	undefined
owner	any	null

Returns

Promise<IEventData[]>

Implementation of

IModelsDatastore.findEvents

Inherited from

ModelsDatastoreDB.findEvents

Defined in

datastore/ModelsDatastoreDB.ts:97

---

getList

▸ getList(query?): Promise<string[]>

Parameters

Name	Type	Default value
query	any	null

Returns

Promise<string[]>

Implementation of

IModelsDatastore.getList

Overrides

ModelsDatastoreDB.getList

Defined in

datastore/ModelsDatastore.ts:30

---

getSVG

▸ getSVG(name, owner?): Promise<string>

Parameters

Name	Type	Default value
name	any	undefined
owner	any	null

Returns

Promise<string>

Implementation of

IModelsDatastore.getSVG

Overrides

ModelsDatastoreDB.getSVG

Defined in

datastore/ModelsDatastore.ts:84

---

getSource

▸ getSource(name, owner?): Promise<string>

Parameters

Name	Type	Default value
name	any	undefined
owner	any	null

Returns

Promise<string>

Implementation of

IModelsDatastore.getSource

Overrides

ModelsDatastoreDB.getSource

Defined in

datastore/ModelsDatastore.ts:79

---

import

▸ import(data, owner?): Promise<any>

Parameters

Name	Type	Default value
data	any	undefined
owner	any	null

Returns

Promise<any>

Implementation of

IModelsDatastore.import

Overrides

ModelsDatastoreDB.import

Defined in

datastore/ModelsDatastore.ts:25

---

install

▸ install(): Promise<any>

first time installation of DB

creates a new collection and add an index

Returns

Promise<any>

Implementation of

IModelsDatastore.install

Inherited from

ModelsDatastoreDB.install

Defined in

datastore/ModelsDatastoreDB.ts:157

---

load

▸ load(name, owner?): Promise<Definition>

Parameters

Name	Type	Default value
name	any	undefined
owner	any	null

Returns

Promise<Definition>

Implementation of

IModelsDatastore.load

Overrides

ModelsDatastoreDB.load

Defined in

datastore/ModelsDatastore.ts:49

---

loadModel

▸ loadModel(name, owner?): Promise<BpmnModelData>

Parameters

Name	Type	Default value
name	any	undefined
owner	any	null

Returns

Promise<BpmnModelData>

Implementation of

IModelsDatastore.loadModel

Inherited from

ModelsDatastoreDB.loadModel

Defined in

datastore/ModelsDatastoreDB.ts:68

---

rebuild

▸ rebuild(model?): Promise<void>

reconstruct the models database from files

use when modifying the files manually or importing new environment

Parameters

Name	Type	Default value
model	any	null

Returns

Promise<void>

Overrides

ModelsDatastoreDB.rebuild

Defined in

datastore/ModelsDatastore.ts:128

---

renameModel

▸ renameModel(name, newName, owner?): Promise<boolean>

Parameters

Name	Type	Default value
name	any	undefined
newName	any	undefined
owner	any	null

Returns

Promise<boolean>

Implementation of

IModelsDatastore.renameModel

Overrides

ModelsDatastoreDB.renameModel

Defined in

datastore/ModelsDatastore.ts:110

---

save

▸ save(name, bpmn, svg?, owner?): Promise<boolean>

Parameters

Name	Type	Default value
name	any	undefined
bpmn	any	undefined
svg?	any	undefined
owner	any	null

Returns

Promise<boolean>

Implementation of

IModelsDatastore.save

Overrides

ModelsDatastoreDB.save

Defined in

datastore/ModelsDatastore.ts:88

---

saveModel

▸ saveModel(model, owner?): Promise<boolean>

Parameters

Name	Type	Default value
model	IBpmnModelData	undefined
owner	any	null

Returns

Promise<boolean>

Implementation of

IModelsDatastore.saveModel

Inherited from

ModelsDatastoreDB.saveModel

Defined in

datastore/ModelsDatastoreDB.ts:190

---

updateTimer

▸ updateTimer(name, owner?): Promise<boolean>

Parameters

Name	Type	Default value
name	any	undefined
owner	any	null

Returns

Promise<boolean>

Inherited from

ModelsDatastoreDB.updateTimer

Defined in

datastore/ModelsDatastoreDB.ts:164