Interface DomainModel

See: relevant section in reference guide

interface DomainModel {
    $CreationOptions?: unknown;
    $ID: string;
    $Type: "DomainModels$DomainModel";
    annotations: Annotation[];
    associations: Association[];
    crossAssociations: CrossAssociation[];
    documentation: string;
    entities: Entity[];
    addAnnotation(): Promise<Annotation>;
    addAssociation(options: AssociationCreationOptions): Promise<Association>;
    addCrossAssociation(options: CrossAssociationCreationOptions): Promise<CrossAssociation>;
    addEntity(options: EntityCreationOptions): Promise<Entity>;
    getAssociation(name: string): Association;
    getCrossAssociation(name: string): CrossAssociation;
    getEntity(name: string): Entity;
}

Hierarchy (view full)

ModuleDocumentBase
- DomainModel

Index

Properties

$CreationOptions? $ID $Type annotations associations crossAssociations documentation entities

Methods

addAnnotation addAssociation addCrossAssociation addEntity getAssociation getCrossAssociation getEntity

Properties

`Optional`$CreationOptions

$CreationOptions?: unknown

Options to pass during the element creation

$ID

$ID: string

The unique id of the element.

$Type

$Type

The type of the element.

annotations

annotations: Annotation[]

associations

associations: Association[]

crossAssociations

crossAssociations: CrossAssociation[]

documentation

documentation: string

entities

entities: Entity[]

Methods

addAnnotation

addAnnotation(): Promise<Annotation>
Returns Promise<Annotation>

addAssociation

addAssociation(options): Promise<Association>
Parameters
- options: AssociationCreationOptions
Returns Promise<Association>

addCrossAssociation

addCrossAssociation(options): Promise<CrossAssociation>
Parameters
- options: CrossAssociationCreationOptions
Returns Promise<CrossAssociation>

addEntity

addEntity(options): Promise<Entity>
Parameters
- options: EntityCreationOptions
Returns Promise<Entity>

getAssociation

getAssociation(name): Association
Parameters
- name: string
Returns Association

getCrossAssociation

getCrossAssociation(name): CrossAssociation
Parameters
- name: string
Returns CrossAssociation

getEntity

getEntity(name): Entity
Parameters
- name: string
Returns Entity