Interface Entity

See: relevant section in reference guide

interface Entity {
    $CreationOptions?: EntityCreationOptions;
    $ID: string;
    $Type: "DomainModels$Entity";
    accessRules: AccessRule[];
    attributes: Attribute[];
    dataStorageGuid: string;
    documentation: string;
    eventHandlers: EventHandler[];
    generalization: GeneralizationBase;
    image: null | string;
    imageData: any;
    indexes: Index[];
    location: Location;
    name: string;
    source: null | EntitySource;
    validationRules: ValidationRule[];
    addAccessRule(): Promise<AccessRule>;
    addAttribute(options: AttributeCreationOptions): Promise<Attribute>;
    addEventHandler(): Promise<EventHandler>;
    addIndex(): Promise<Index>;
    addValidationRule(): Promise<ValidationRule>;
    delete(): void;
    getAttribute(name: string): Attribute;
    getContainer(): DomainModel;
}

Hierarchy (view full)

ElementBase
- Entity

Properties

`Optional`$CreationOptions

$CreationOptions?: EntityCreationOptions

Options to pass during the element creation

$ID

$ID: string

The unique id of the element.

$Type

$Type

The type of the element.

accessRules

accessRules: AccessRule[]

attributes

attributes: Attribute[]

dataStorageGuid

dataStorageGuid: string

documentation

documentation: string

eventHandlers

eventHandlers: EventHandler[]

generalization

generalization: GeneralizationBase

image

image: null | string

imageData

imageData: any

indexes

indexes: Index[]

location

location: Location

name

name: string

source

source: null | EntitySource

validationRules

validationRules: ValidationRule[]

Methods

addAccessRule

addAccessRule(): Promise<AccessRule>
Returns Promise<AccessRule>

addAttribute

addAttribute(options): Promise<Attribute>
Parameters
- options: AttributeCreationOptions
Returns Promise<Attribute>

addEventHandler

addEventHandler(): Promise<EventHandler>
Returns Promise<EventHandler>

addIndex

addIndex(): Promise<Index>
Returns Promise<Index>

addValidationRule

addValidationRule(): Promise<ValidationRule>
Returns Promise<ValidationRule>

delete

delete(): void
Returns void

getAttribute

getAttribute(name): Attribute
Parameters
- name: string
Returns Attribute

getContainer

getContainer(): DomainModel
Returns DomainModel