API Reference › core-backend› Models › DefinitionModel

DefinitionModel Class @preview

A container for persisting definition elements.

@see DefinitionPartition

Extends

Extended by

Methods

Name Description
constructor(props: ModelProps, iModel: IModelDb): DefinitionModel Protected    
insert(iModelDb: IModelDb, parentSubjectId: string, name: string): string Static Insert a DefinitionPartition and a DefinitionModel that sub-models it.  

Inherited methods

Name Inherited from Description
collectReferenceIds(referenceIds: EntityReferenceSet): void Protected Inherited InformationModel Collect the Ids of this entity's references at this level of the class hierarchy.
delete(): void Inherited InformationModel Delete this Model from the iModel.
forEach(func: PropertyHandler, includeCustom: boolean = true): void Inherited InformationModel Call a function for each property of this Entity.
forEachProperty(func: PropertyCallback, includeCustom: boolean = true): void Inherited InformationModel Call a function for each property of this Entity.
getJsonProperty(name: string): any Inherited InformationModel  
getMetaData(): Promise<EntityClass | RelationshipClass> Inherited InformationModel Query metadata for this entity class from the iModel's schema.
getReferenceIds(): EntityReferenceSet Inherited InformationModel Get the set of this entity's entity references, EntityReferenceSet.
getUserProperties(namespace: string): any Inherited InformationModel Get a set of JSON user properties by namespace
insert(): string Inherited InformationModel Insert this Model in the iModel
removeUserProperties(nameSpace: string): void Inherited InformationModel Remove a set of JSON user properties, specified by namespace, from this Element
setJsonProperty(name: string, value: any): void Inherited InformationModel  
setUserProperties(nameSpace: string, value: any): void Inherited InformationModel Change a set of user JSON properties of this Element by namespace.
toJSON(): ModelProps Inherited InformationModel Obtain the JSON representation of this Entity.
update(): void Inherited InformationModel Update this Model in the iModel.
deserialize(props: DeserializeEntityArgs): ModelProps Static Inherited InformationModel Converts an ECSqlRow of an Entity to an EntityProps.
is(otherClass: Entity): boolean Static Inherited InformationModel return whether this Entity class is a subclass of another Entity class
onDelete(arg: OnModelIdArg): void Protected Static Inherited InformationModel Called before a Model is deleted.
onDeleted(arg: OnModelIdArg): void Protected Static Inherited InformationModel Called after a Model was deleted.
onDeletedElement(arg: OnElementInModelIdArg): void Protected Static Inherited InformationModel Called after an Element in an instance of a Model of this class has been deleted.
onDeleteElement(_arg: OnElementInModelIdArg): void Protected Static Inherited InformationModel Called when an Element in an instance of a Model of this class is about to be deleted.
onInsert(arg: OnModelPropsArg): void Protected Static Inherited InformationModel Called before a new Model is inserted.
onInserted(_arg: OnModelIdArg): void Protected Static Inherited InformationModel Called after a new Model is inserted.
onInsertedElement(arg: OnElementInModelIdArg): void Protected Static Inherited InformationModel Called after an Element has been inserted into an instance of a Model of this class.
onInsertElement(_arg: OnElementInModelPropsArg): void Protected Static Inherited InformationModel Called before a prospective Element is to be inserted into an instance of a Model of this class.
onUpdate(arg: OnModelPropsArg): void Protected Static Inherited InformationModel Called before a Model is updated.
onUpdated(arg: OnModelIdArg): void Protected Static Inherited InformationModel Called after a Model is updated.
onUpdatedElement(arg: OnElementInModelIdArg): void Protected Static Inherited InformationModel Called after an Element in an instance of a Model of this class has been updated.
onUpdateElement(_arg: OnElementInModelPropsArg): void Protected Static Inherited InformationModel Called when an Element in an instance of a Model of this class is about to be updated.
serialize(props: ModelProps, _iModel: IModelDb): ECSqlRow Static Inherited InformationModel Converts an EntityProps to an ECSqlRow.

Properties

Name Type Description
className Accessor Static ReadOnly string The name of the BIS class associated with this class.  

Inherited properties

Name Type Inherited from Description
_customHandledProps Protected Static Readonly Inherited CustomHandledProperty[] InformationModel List of properties that are need to be custom handled during deserialization and serialization.
_metadata Protected Inherited EntityClass | RelationshipClass InformationModel Cached Metadata for the ECClass
classFullName Accessor Inherited ReadOnly string InformationModel Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor Static Inherited ReadOnly string InformationModel Get the full BIS class name of this Entity in the form "schema:class"
className Accessor Inherited ReadOnly string InformationModel The name of the BIS class associated with this class.
id Inherited string InformationModel The Id of this Entity.
iModel Inherited IModelDb InformationModel The IModelDb that contains this Entity
isInstanceOfEntity Readonly Inherited "true" InformationModel An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types
isPrivate Inherited boolean InformationModel  
isTemplate Inherited boolean InformationModel  
jsonProperties Readonly Inherited [key: string]: any InformationModel  
modeledElement Readonly Inherited RelatedElement InformationModel  
name Readonly Inherited string InformationModel  
parentModel Readonly Inherited string | undefined InformationModel  
schema Static Inherited Schema InformationModel The Schema that defines this class.
schemaItemKey Accessor Inherited ReadOnly SchemaItemKey InformationModel Get the item key used by the ecschema-metadata package to identify this entity class
schemaItemKey Accessor Static Inherited ReadOnly SchemaItemKey InformationModel Serves as a unique identifier for this class. Typed variant of classFullName.
schemaName Accessor Inherited ReadOnly string InformationModel The name of the BIS Schema that defines this class

Defined in

Last Updated: 28 October, 2025