Interface DomainModel

See: relevant section in reference guide

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

Hierarchy

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: "DomainModels$DomainModel"

The type of the element.

annotations

annotations: DomainModels.Annotation[]

associations

associations: Association[]

crossAssociations

crossAssociations: CrossAssociation[]

documentation

documentation: string

entities

entities: Entity[]

Methods

addAnnotation

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

addAssociation

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

addCrossAssociation

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

addEntity

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

getAssociation

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

getCrossAssociation

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

getEntity

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