ConsumedBusinessEventService | Mendix Model SDK

In version 9.24.0: deleted In version 9.8.0: introduced

Hierarchy

Document
- ConsumedBusinessEventService

Implements

IConsumedBusinessEventService

Constructors

constructor

new ConsumedBusinessEventService(model: AbstractModel, structureTypeName: string, id: string, isPartial: boolean, container: IFolderBase): ConsumedBusinessEventService

Overrides Document.constructor
Parameters
- model: AbstractModel
- structureTypeName: string
- id: string
- isPartial: boolean
- container: IFolderBase
Returns ConsumedBusinessEventService

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "BusinessEvents$ConsumedBusinessEventService"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

businessEvents

get businessEvents(): IList<ConsumedBusinessEvent>

In version 9.11.0: introduced

Returns IList<ConsumedBusinessEvent>

container

get container(): TContainer

Implementation of IConsumedBusinessEventService.container
Inherited from projects.Document.container

The parent unit of this unit.

Returns TContainer

containerAsFolderBase

get containerAsFolderBase(): FolderBase

Implementation of IConsumedBusinessEventService.containerAsFolderBase
Overrides projects.Document.containerAsFolderBase
Returns FolderBase

containerAsModule

get containerAsModule(): Module

Implementation of IConsumedBusinessEventService.containerAsModule
Inherited from projects.Document.containerAsModule
Returns Module

contract

get contract(): string
set contract(newValue: string): void

In version 9.11.0: introduced

Returns string
In version 9.11.0: introduced

Parameters
- newValue: string
Returns void

documentation

get documentation(): string
set documentation(newValue: string): void

Implementation of IConsumedBusinessEventService.documentation
Inherited from projects.Document.documentation

In version 9.10.0: added public

Returns string
Implementation of IConsumedBusinessEventService.documentation
Inherited from projects.Document.documentation

In version 9.10.0: added public

Parameters
- newValue: string
Returns void

excluded

get excluded(): boolean
set excluded(newValue: boolean): void

Implementation of IConsumedBusinessEventService.excluded
Inherited from projects.Document.excluded

In version 9.11.0: added public

Returns boolean
Implementation of IConsumedBusinessEventService.excluded
Inherited from projects.Document.excluded

In version 9.11.0: added public

Parameters
- newValue: boolean
Returns void

exportLevel

get exportLevel(): ExportLevel
set exportLevel(newValue: ExportLevel): void

Inherited from projects.Document.exportLevel

In version 9.3.0: introduced

Returns ExportLevel
Inherited from projects.Document.exportLevel

In version 9.3.0: introduced

Parameters
- newValue: ExportLevel
Returns void

isLoadable

get isLoadable(): boolean

Implementation of IConsumedBusinessEventService.isLoadable
Inherited from projects.Document.isLoadable

Whether this unit and all of its children (recursively) can be loaded.

Returns boolean

isLoaded

get isLoaded(): boolean

Implementation of IConsumedBusinessEventService.isLoaded
Inherited from projects.Document.isLoaded

Whether this unit has been completely loaded and does not consist of the unit's interface (which corresponds to the unit being partial).

Returns boolean

isReadOnly

get isReadOnly(): boolean

Implementation of IConsumedBusinessEventService.isReadOnly
Inherited from projects.Document.isReadOnly

Whether this unit and all of its children (recursively) are editable.

Returns boolean

model

get model(): TModel

Implementation of IConsumedBusinessEventService.model
Inherited from projects.Document.model
Returns TModel

name

get name(): string
set name(newValue: string): void

Implementation of IConsumedBusinessEventService.name
Inherited from projects.Document.name
Returns string
Implementation of IConsumedBusinessEventService.name
Inherited from projects.Document.name
Parameters
- newValue: string
Returns void

qualifiedName

get qualifiedName(): null | string

Implementation of IConsumedBusinessEventService.qualifiedName
Inherited from projects.Document.qualifiedName

Returns the qualified name of this element, or null if this element is not a part of the model, or if it or one of its namespace containers does not have a valid name.

Returns null | string

unit

get unit(): this

Implementation of IConsumedBusinessEventService.unit
Inherited from projects.Document.unit

Unit that owns/contains this thing.

Returns this

version

get version(): string
set version(newValue: string): void

In version 9.11.0: introduced

Returns string
In version 9.11.0: introduced

Parameters
- newValue: string
Returns void

Methods

allProperties

allProperties(): AbstractProperty<any, any>[]

Implementation of IConsumedBusinessEventService.allProperties
Inherited from Document.allProperties
Returns AbstractProperty<any, any>[]

asLoaded

asLoaded(): ConsumedBusinessEventService

Implementation of IConsumedBusinessEventService.asLoaded
Inherited from Document.asLoaded
Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)
- If invoked without callback, it checks whether the properties are available or it will throw;
- If invoked with callback, it will load the data from the server if needed, and then invoke the callback.
Returns ConsumedBusinessEventService

delete

delete(): void

Implementation of IConsumedBusinessEventService.delete
Inherited from Document.delete

Deletes this element from the model.

Returns void

findElementById

findElementById(id: string): null | AbstractElement<IAbstractModel, Container>

Implementation of IConsumedBusinessEventService.findElementById
Inherited from Document.findElementById

Given an element id, returns the element in this abstract element with that id, otherwise null.

Parameters
- id: string
Returns null | AbstractElement<IAbstractModel, Container>

Protected getContainerAs

getContainerAs<T>(containerType: any): T

Inherited from Document.getContainerAs
Type parameters
- T: IContainer
Parameters
- containerType: any
Returns T

load

load(callback: (elem: ConsumedBusinessEventService) => void, forceRefresh?: boolean): void
load(forceRefresh?: boolean): Promise<ConsumedBusinessEventService>

Implementation of IConsumedBusinessEventService.load
Inherited from Document.load
Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)
- If invoked without callback, it checks whether the properties are available or it will throw;
- If invoked with callback, it will load the data from the server if needed, and then invoke the callback.
Parameters
- callback: (elem: ConsumedBusinessEventService) => void
  - - (elem: ConsumedBusinessEventService): void
    - Parameters
      - elem: ConsumedBusinessEventService
      Returns void
- Optional forceRefresh: boolean
Returns void
Implementation of IConsumedBusinessEventService.load
Inherited from Document.load
Parameters
- Optional forceRefresh: boolean
Returns Promise<ConsumedBusinessEventService>

loadedProperties

loadedProperties(): AbstractProperty<any, any>[]

Implementation of IConsumedBusinessEventService.loadedProperties
Inherited from Document.loadedProperties

Returns all properties when this structure is loaded, otherwise just the public properties.

Returns AbstractProperty<any, any>[]

publicProperties

publicProperties(): AbstractProperty<any, any>[]

Implementation of IConsumedBusinessEventService.publicProperties
Inherited from Document.publicProperties
Returns AbstractProperty<any, any>[]

toJSON

toJSON(): IAbstractElementJson

Implementation of IConsumedBusinessEventService.toJSON
Inherited from Document.toJSON

Renders the structure as plain JSON (without observables magic). This is intended for debugging and development convenience. Note that the resulting object is not of the interface type corresponding to this structure.

Returns IAbstractElementJson

traverse

traverse(visit: (structure: IStructure) => void): void

Implementation of IConsumedBusinessEventService.traverse
Inherited from Document.traverse

Traverses this structure by calling the provided visitor function on itself and all the structures contained (as part) by it, in depth-first order, and it returns synchronously after that.

Parameters
- visit: (structure: IStructure) => void
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

traverseFind

traverseFind<T>(visit: (structure: IStructure) => T): null | T

Implementation of IConsumedBusinessEventService.traverseFind
Inherited from Document.traverseFind

Traverses this structure, returning immediately when visit returns something other than null.

Type parameters
- T
Parameters
- visit: (structure: IStructure) => T
  - - (structure: IStructure): T
    - Parameters
      - structure: IStructure
      Returns T
Returns null | T

traversePublicParts

traversePublicParts(visit: (structure: IStructure) => void): void

Implementation of IConsumedBusinessEventService.traversePublicParts
Inherited from Document.traversePublicParts

Traverses this structure, only visiting children contained in public properties.

Parameters
- visit: (structure: IStructure) => void
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

Static createIn

createIn(container: IFolderBase): ConsumedBusinessEventService

Creates a new ConsumedBusinessEventService unit in the SDK and on the server. Expects one argument, the projects.IFolderBase in which this unit is contained.

Parameters
- container: IFolderBase
Returns ConsumedBusinessEventService

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

model: AbstractModel

structureTypeName: string

id: string

isPartial: boolean

container: IFolderBase

Returns ConsumedBusinessEventService

Properties

id

structureTypeName

Static structureTypeName

Static versionInfo

Accessors

businessEvents

Returns IList<ConsumedBusinessEvent>

container

Returns TContainer

containerAsFolderBase

Returns FolderBase

containerAsModule

Returns Module

contract

Returns string

Parameters

newValue: string

Returns void

documentation

Returns string

Parameters

newValue: string

Returns void

excluded

Returns boolean

Parameters

newValue: boolean

Returns void

exportLevel

Returns ExportLevel

Parameters

newValue: ExportLevel

Returns void

isLoadable

Returns boolean

isLoaded

Returns boolean

isReadOnly

Returns boolean

model

Returns TModel

name

Returns string

Parameters

newValue: string

Returns void

qualifiedName

Returns null | string

unit

Returns this

version

Returns string

Parameters

newValue: string

Returns void

Methods

allProperties

Returns AbstractProperty<any, any>[]

asLoaded

Returns ConsumedBusinessEventService

delete

Returns void

findElementById