Interface DataModel

Api for accessing the Datamodel

Note that this always already contains all changes when the Plugin scripts are executed

interface DataModel {
    create(typePersistentName: BuildingBlockType): BuildingBlock;
    findByType(typePersistentName: BuildingBlockType): BuildingBlock[];
    findByTypeAndId(
        typePersistentName: BuildingBlockType,
        id: number,
    ): BuildingBlock;
    findByTypeAndName(
        typePersistentName: BuildingBlockType,
        name: string,
        options: { ignoreCase: boolean },
    ): BuildingBlock;
    getAllPropertyNamesByType(typePersistentName: BuildingBlockType): string[];
    getAllRelationNamesByType(typePersistentName: BuildingBlockType): string[];
    getAllTypeNames(): BuildingBlockType[];
}

Index

Methods

create findByType findByTypeAndId findByTypeAndName getAllPropertyNamesByType getAllRelationNamesByType getAllTypeNames

Methods

create

create(typePersistentName: BuildingBlockType): BuildingBlock
Creates a new object of the given type in the model and returns it.
Parameters
- typePersistentName: BuildingBlockType
  Persistent name of the building block type
Returns BuildingBlock

findByType

findByType(typePersistentName: BuildingBlockType): BuildingBlock[]
Ge an array containing all Building Block objects of the given type in the model.
Parameters
- typePersistentName: BuildingBlockType
  Persistent name of the building block type
Returns BuildingBlock[]

findByTypeAndId

findByTypeAndId(
typePersistentName: BuildingBlockType,
id: number,
): BuildingBlock
Get a Building Block object with the given type and id. Null if there is no such object.
Parameters
- typePersistentName: BuildingBlockType
  Persistent name of the building block type
- id: number
  Id of the building block
Returns BuildingBlock

findByTypeAndName

findByTypeAndName(
    typePersistentName: BuildingBlockType,
    name: string,
    options: { ignoreCase: boolean },
): BuildingBlock
Get a Building Block object with the given type and name. Returns {@code null} if there is no such object. Name matching is case-sensitive by default. You may pass additional option to make it case-insensitive.
Parameters
- typePersistentName: BuildingBlockType
  Persistent name of the building block type
- name: string
  Name of the building block
- options: { ignoreCase: boolean }
  Matching options
Returns BuildingBlock

getAllPropertyNamesByType

getAllPropertyNamesByType(typePersistentName: BuildingBlockType): string[]
Get the names of all properties of a Building Block Type.
Parameters
- typePersistentName: BuildingBlockType
  Persistent name of the building block type
Returns string[]

getAllRelationNamesByType

getAllRelationNamesByType(typePersistentName: BuildingBlockType): string[]
Get the names of all relation ends connected to the Building Block Type.
Parameters
- typePersistentName: BuildingBlockType
  Persistent name of the building block type
Returns string[]

getAllTypeNames

getAllTypeNames(): BuildingBlockType[]
Names of all Building Block Types in the metamodel.

Returns BuildingBlockType[]