API Reference › core-backend › Elements › GroupModel

GroupModel Class

A generic container for BisCore:GroupInformationElement instances.

Extends

Methods

Name Description
constructor(props: ModelProps, iModel: IModelDb): GroupModel    
insert(iModelDb: IModelDb, parentSubjectId: string, name: string): string Static Insert a GroupInformationPartition and a GroupModel that breaks it down.  

Inherited methods

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

Inherited properties

Name Type Inherited from Description
classFullName Accessor ReadOnly string GroupInformationModel Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor StaticReadOnly string GroupInformationModel Get the full BIS class name of this Entity in the form "schema:class"
className Accessor ReadOnly string GroupInformationModel The name of the BIS class associated with this class.
id string GroupInformationModel The Id of this Entity.
iModel IModelDb GroupInformationModel The IModelDb that contains this Entity
isInstanceOfEntity Readonly "true" GroupInformationModel An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types
isPrivate boolean GroupInformationModel  
isTemplate boolean GroupInformationModel  
jsonProperties Readonly { T } GroupInformationModel  
modeledElement Readonly RelatedElement GroupInformationModel  
name Readonly string GroupInformationModel  
parentModel Readonly string GroupInformationModel  
schema Static undefined GroupInformationModel The Schema that defines this class.
schemaName Accessor ReadOnly string GroupInformationModel The name of the BIS Schema that defines this class

Defined in

Last Updated: 16 April, 2024