Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Model

Implementation of IModel.

Hierarchy

  • BaseModel
    • Model

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

metaModelVersion

metaModelVersion: Version

mxVersionForModel

mxVersionForModel: Version

workingCopy

workingCopy: IWorkingCopy

Accessors

id

  • get id(): string

  • Returns string

root

  • Returns the structural unit of type "Projects$Project" which is the project's root, cast to the appropriate type.

    Returns IProject

Methods

addModuleUnitInterfaces

  • Parameters

    Returns IStructuralUnit

allBuildingBlocks

  • Returns IBuildingBlock[]

allBusinessEventServices

  • allBusinessEventServices(): IBusinessEventService[]

  • Returns IBusinessEventService[]

allCodeActions

  • Returns ICodeAction[]

allConnectorTypes

  • allConnectorTypes(): IConnectorType[]

  • Returns IConnectorType[]

allConnectors

  • allConnectors(): IConnector[]

  • Returns IConnector[]

allConstants

  • Returns IConstant[]

allConsumedAppServices

  • Returns IConsumedAppService[]

allConsumedBusinessEventServices

  • Returns IConsumedBusinessEventService[]

allConsumedKafkaServices

  • allConsumedKafkaServices(): IConsumedKafkaService[]

  • Returns IConsumedKafkaService[]

allConsumedODataServices

  • Returns IConsumedODataService[]

allConsumedRestServices

  • Returns IConsumedRestService[]

allCustomIconCollections

  • Returns ICustomIconCollection[]

allDataSets

  • Returns IDataSet[]

allDatabaseConnections

  • Returns IDatabaseConnection[]

allDocumentTemplates

  • Returns IDocumentTemplate[]

allDocuments

  • Returns IDocument[]

allDomainModels

  • Returns IDomainModel[]

allEnumerations

  • Returns IEnumeration[]

allExportMappings

  • Returns IExportMapping[]

allFolderBases

  • Returns IFolderBase[]

allFolders

  • Returns IFolder[]

allFormBases

  • Returns IFormBase[]

allImageCollections

  • Returns IImageCollection[]

allImportMappings

  • Returns IImportMapping[]

allImportedWebServices

  • Returns IImportedWebService[]

allJavaActions

  • Returns IJavaAction[]

allJavaScriptActions

  • Returns IJavaScriptAction[]

allJsonStructures

  • Returns IJsonStructure[]

allLayouts

  • Returns ILayout[]

allMLMappingDocuments

  • allMLMappingDocuments(): IMLMappingDocument[]

  • Returns IMLMappingDocument[]

allMappingDocuments

  • Returns IMappingDocument[]

allMappingSourceDocuments

  • Returns IMappingSourceDocument[]

allMenuDocuments

  • Returns IMenuDocument[]

allMessageDefinitionCollections

  • Returns IMessageDefinitionCollection[]

allMicroflowBases

  • Returns IMicroflowBase[]

allMicroflows

  • Returns IMicroflow[]

allModuleDocuments

  • Returns IModuleDocument[]

allModuleSecurities

  • Returns IModuleSecurity[]

allModuleSettings

  • Returns IModuleSettings[]

allModules

  • Returns IModule[]

allMxSchemas

  • Returns IMxSchema[]

allNanoflows

  • Returns INanoflow[]

allNativeLayouts

  • allNativeLayouts(): INativeLayout[]

  • Returns INativeLayout[]

allNativePages

  • allNativePages(): INativePage[]

  • Returns INativePage[]

allNavigationDocuments

  • Returns INavigationDocument[]

allPageTemplates

  • Returns IPageTemplate[]

allPages

  • Returns IPage[]

allProjectConversions

  • Returns IProjectConversion[]

allProjectDocuments

  • Returns IProjectDocument[]

allProjectSecurities

  • Returns IProjectSecurity[]

allProjectSettings

  • Returns IProjectSettings[]

allProjects

  • Returns IProject[]

allPublishedAppServices

  • Returns IPublishedAppService[]

allPublishedBusinessEventServices

  • Returns IPublishedBusinessEventService[]

allPublishedKafkaServices

  • allPublishedKafkaServices(): IPublishedKafkaService[]

  • Returns IPublishedKafkaService[]

allPublishedODataService2s

  • Returns IPublishedODataService2[]

allPublishedODataServices

  • Returns IPublishedODataService[]

allPublishedRestServices

  • Returns IPublishedRestService[]

allPublishedServiceBases

  • Returns IPublishedServiceBase[]

allPublishedWebServices

  • Returns IPublishedWebService[]

allQueues

  • Returns IQueue[]

allRegularExpressions

  • Returns IRegularExpression[]

allRemoteEntitySourceDocuments

  • allRemoteEntitySourceDocuments(): IRemoteEntitySourceDocument[]

  • Returns IRemoteEntitySourceDocument[]

allRules

  • Returns IRule[]

allScheduledEvents

  • Returns IScheduledEvent[]

allServerSideMicroflows

  • Returns IServerSideMicroflow[]

allSnippets

  • Returns ISnippet[]

allSystemTextCollections

  • Returns ISystemTextCollection[]

allTemplateFormBases

  • Returns ITemplateFormBase[]

allTemplates

  • allTemplates(): ITemplate[]

  • Returns ITemplate[]

allUnits

  • Returns a defensive collection of all units in this model.

    Returns IAbstractUnit[]

allViewEntitySourceDocuments

  • allViewEntitySourceDocuments(): IViewEntitySourceDocument[]

  • Returns IViewEntitySourceDocument[]

allWorkflows

  • Returns IWorkflow[]

allXmlSchemas

  • Returns IXmlSchema[]

closeConnection

  • Parameters

    Returns void

  • Returns Promise<void>

createElement

  • createElement<T>(typeName: T): ConcreteModelElements[T]

  • Type parameters

    • T: keyof ConcreteModelElements

    Parameters

    • typeName: T

    Returns ConcreteModelElements[T]

deleteFile

  • Parameters

    Returns void

  • Parameters

    • filePath: string

    Returns Promise<void>

deleteWorkingCopy

  • Deletes this working copy from the server, and the (SDK) client.

    Parameters

    Returns void

  • Returns Promise<void>

exportModuleMpk

  • exportModuleMpk(moduleId: string, outFilePath: string, callback: IVoidCallback, errorCallback?: IErrorCallback): void
  • exportModuleMpk(moduleId: string, outFilePath: string): Promise<void>

  • Parameters

    Returns void

  • Parameters

    • moduleId: string
    • outFilePath: string

    Returns Promise<void>

exportMpk

  • Parameters

    Returns void

  • Parameters

    • outFilePath: string

    Returns Promise<IExportMpkResponse>

filterUnitsByCustomWidgetId

  • filterUnitsByCustomWidgetId(workingCopyId: string, widgetId: string, callback: ICallback<string[]>, errorCallback: IErrorCallback): void
  • filterUnitsByCustomWidgetId(workingCopyId: string, widgetId: string): Promise<string[]>

  • Parameters

    Returns void

  • Parameters

    • workingCopyId: string
    • widgetId: string

    Returns Promise<string[]>

findAppServiceActionByQualifiedName

  • Parameters

    • qname: string

    Returns null | IAppServiceAction

findAppServiceActionParameterByQualifiedName

  • Parameters

    • qname: string

    Returns null | IAppServiceActionParameter

findAssociationBaseByQualifiedName

  • Parameters

    • qname: string

    Returns null | IAssociationBase

findAttributeByQualifiedName

  • findAttributeByQualifiedName(qname: string): null | IAttribute

  • Parameters

    • qname: string

    Returns null | IAttribute

findCSVSheetByQualifiedName

  • findCSVSheetByQualifiedName(qname: string): null | ICSVSheet

  • Parameters

    • qname: string

    Returns null | ICSVSheet

findConnectorActionByQualifiedName

  • findConnectorActionByQualifiedName(qname: string): null | IConnectorAction

  • Parameters

    • qname: string

    Returns null | IConnectorAction

findConnectorPropertyByQualifiedName

  • findConnectorPropertyByQualifiedName(qname: string): null | IConnectorProperty

  • Parameters

    • qname: string

    Returns null | IConnectorProperty

findConnectorTypeByQualifiedName

  • findConnectorTypeByQualifiedName(qname: string): null | IConnectorType

  • Parameters

    • qname: string

    Returns null | IConnectorType

findConstantByQualifiedName

  • findConstantByQualifiedName(qname: string): null | IConstant

  • Parameters

    • qname: string

    Returns null | IConstant

findConsumedKafkaServiceByQualifiedName

  • findConsumedKafkaServiceByQualifiedName(qname: string): null | IConsumedKafkaService

  • Parameters

    • qname: string

    Returns null | IConsumedKafkaService

findConsumedODataServiceByQualifiedName

  • Parameters

    • qname: string

    Returns null | IConsumedODataService

findCustomIconByQualifiedName

  • findCustomIconByQualifiedName(qname: string): null | ICustomIcon

  • Parameters

    • qname: string

    Returns null | ICustomIcon

findDataSetByQualifiedName

  • findDataSetByQualifiedName(qname: string): null | IDataSet

  • Parameters

    • qname: string

    Returns null | IDataSet

findDataSetParameterByQualifiedName

  • Parameters

    • qname: string

    Returns null | IDataSetParameter

findDatabaseQueryByQualifiedName

  • findDatabaseQueryByQualifiedName(qname: string): null | IDatabaseQuery

  • Parameters

    • qname: string

    Returns null | IDatabaseQuery

findDocumentTemplateByQualifiedName

  • Parameters

    • qname: string

    Returns null | IDocumentTemplate

findEntityByQualifiedName

  • findEntityByQualifiedName(qname: string): null | IEntity

  • Parameters

    • qname: string

    Returns null | IEntity

findEnumerationByQualifiedName

  • findEnumerationByQualifiedName(qname: string): null | IEnumeration

  • Parameters

    • qname: string

    Returns null | IEnumeration

findEnumerationValueByQualifiedName

  • Parameters

    • qname: string

    Returns null | IEnumerationValue

findExcelSheetByQualifiedName

  • findExcelSheetByQualifiedName(qname: string): null | IExcelSheet

  • Parameters

    • qname: string

    Returns null | IExcelSheet

findExportMappingByQualifiedName

  • findExportMappingByQualifiedName(qname: string): null | IExportMapping

  • Parameters

    • qname: string

    Returns null | IExportMapping

findImageByQualifiedName

  • findImageByQualifiedName(qname: string): null | IImage

  • Parameters

    • qname: string

    Returns null | IImage

findImportMappingByQualifiedName

  • findImportMappingByQualifiedName(qname: string): null | IImportMapping

  • Parameters

    • qname: string

    Returns null | IImportMapping

findImportedWebServiceByQualifiedName

  • Parameters

    • qname: string

    Returns null | IImportedWebService

findJavaActionByQualifiedName

  • findJavaActionByQualifiedName(qname: string): null | IJavaAction

  • Parameters

    • qname: string

    Returns null | IJavaAction

findJavaActionParameterByQualifiedName

  • Parameters

    • qname: string

    Returns null | IJavaActionParameter

findJavaScriptActionByQualifiedName

  • Parameters

    • qname: string

    Returns null | IJavaScriptAction

findJavaScriptActionParameterByQualifiedName

  • Parameters

    • qname: string

    Returns null | IJavaScriptActionParameter

findJsonStructureByQualifiedName

  • findJsonStructureByQualifiedName(qname: string): null | IJsonStructure

  • Parameters

    • qname: string

    Returns null | IJsonStructure

findLayoutByQualifiedName

  • findLayoutByQualifiedName(qname: string): null | ILayout

  • Parameters

    • qname: string

    Returns null | ILayout

findLayoutParameterByQualifiedName

  • Parameters

    • qname: string

    Returns null | ILayoutParameter

findMLMappingDocumentByQualifiedName

  • findMLMappingDocumentByQualifiedName(qname: string): null | IMLMappingDocument

  • Parameters

    • qname: string

    Returns null | IMLMappingDocument

findMenuDocumentByQualifiedName

  • findMenuDocumentByQualifiedName(qname: string): null | IMenuDocument

  • Parameters

    • qname: string

    Returns null | IMenuDocument

findMessageDefinitionByQualifiedName

  • Parameters

    • qname: string

    Returns null | IMessageDefinition

findMicroflowByQualifiedName

  • findMicroflowByQualifiedName(qname: string): null | IMicroflow

  • Parameters

    • qname: string

    Returns null | IMicroflow

findMicroflowParameterByQualifiedName

  • Parameters

    • qname: string

    Returns null | IMicroflowParameter

findModuleByQualifiedName

  • findModuleByQualifiedName(qname: string): null | IModule

  • Parameters

    • qname: string

    Returns null | IModule

findModuleRoleByQualifiedName

  • findModuleRoleByQualifiedName(qname: string): null | IModuleRole

  • Parameters

    • qname: string

    Returns null | IModuleRole

findNanoflowByQualifiedName

  • findNanoflowByQualifiedName(qname: string): null | INanoflow

  • Parameters

    • qname: string

    Returns null | INanoflow

findNanoflowParameterByQualifiedName

  • Parameters

    • qname: string

    Returns null | INanoflowParameter

findNativeLayoutByQualifiedName

  • findNativeLayoutByQualifiedName(qname: string): null | INativeLayout

  • Parameters

    • qname: string

    Returns null | INativeLayout

findNativePageByQualifiedName

  • findNativePageByQualifiedName(qname: string): null | INativePage

  • Parameters

    • qname: string

    Returns null | INativePage

findNavigationProfileByQualifiedName

  • Parameters

    • qname: string

    Returns null | INavigationProfile

findOperationParameterByQualifiedName

  • Parameters

    • qname: string

    Returns null | IOperationParameter

findPageByQualifiedName

  • findPageByQualifiedName(qname: string): null | IPage

  • Parameters

    • qname: string

    Returns null | IPage

findPageParameterByQualifiedName

  • findPageParameterByQualifiedName(qname: string): null | IPageParameter

  • Parameters

    • qname: string

    Returns null | IPageParameter

findParameterByQualifiedName

  • findParameterByQualifiedName(qname: string): null | IParameter

  • Parameters

    • qname: string

    Returns null | IParameter

findQueueByQualifiedName

  • findQueueByQualifiedName(qname: string): null | IQueue

  • Parameters

    • qname: string

    Returns null | IQueue

findRegularExpressionByQualifiedName

  • Parameters

    • qname: string

    Returns null | IRegularExpression

findRemoteEntitySourceDocumentByQualifiedName

  • findRemoteEntitySourceDocumentByQualifiedName(qname: string): null | IRemoteEntitySourceDocument

  • Parameters

    • qname: string

    Returns null | IRemoteEntitySourceDocument

findRestOperationByQualifiedName

  • findRestOperationByQualifiedName(qname: string): null | IRestOperation

  • Parameters

    • qname: string

    Returns null | IRestOperation

findRestParameterByQualifiedName

  • findRestParameterByQualifiedName(qname: string): null | IRestParameter

  • Parameters

    • qname: string

    Returns null | IRestParameter

findRuleByQualifiedName

  • findRuleByQualifiedName(qname: string): null | IRule

  • Parameters

    • qname: string

    Returns null | IRule

findRuleParameterByQualifiedName

  • findRuleParameterByQualifiedName(qname: string): null | IRuleParameter

  • Parameters

    • qname: string

    Returns null | IRuleParameter

findSnippetByQualifiedName

  • findSnippetByQualifiedName(qname: string): null | ISnippet

  • Parameters

    • qname: string

    Returns null | ISnippet

findSnippetParameterByQualifiedName

  • Parameters

    • qname: string

    Returns null | ISnippetParameter

findTemplateByQualifiedName

  • findTemplateByQualifiedName(qname: string): null | ITemplate

  • Parameters

    • qname: string

    Returns null | ITemplate

findUserRoleByQualifiedName

  • findUserRoleByQualifiedName(qname: string): null | IUserRole

  • Parameters

    • qname: string

    Returns null | IUserRole

findUserTaskOutcomeByQualifiedName

  • Parameters

    • qname: string

    Returns null | IUserTaskOutcome

findViewEntitySourceDocumentByQualifiedName

  • findViewEntitySourceDocumentByQualifiedName(qname: string): null | IViewEntitySourceDocument

  • Parameters

    • qname: string

    Returns null | IViewEntitySourceDocument

findWaitForNotificationActivityByQualifiedName

  • Parameters

    • qname: string

    Returns null | IWaitForNotificationActivity

findWorkflowByQualifiedName

  • findWorkflowByQualifiedName(qname: string): null | IWorkflow

  • Parameters

    • qname: string

    Returns null | IWorkflow

findXmlSchemaByQualifiedName

  • findXmlSchemaByQualifiedName(qname: string): null | IXmlSchema

  • Parameters

    • qname: string

    Returns null | IXmlSchema

flushChanges

  • Parameters

    Returns void

  • Returns Promise<void>

getFile

  • getFile(filePath: string, outFilePath: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • getFile(filePath: string, outFilePath: string): Promise<void>

  • Parameters

    Returns void

  • Parameters

    • filePath: string
    • outFilePath: string

    Returns Promise<void>

getFilePaths

  • Parameters

    Returns void

  • Returns Promise<string[]>

getFiles

  • Parameters

    Returns void

  • Returns Promise<string[]>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<any>

getLastEventId

  • Parameters

    Returns void

  • Returns Promise<number>

handleError

  • handleError(message: string, errorCallback: undefined | IErrorCallback): void

  • Parameters

    Returns void

importModuleMpk

  • importModuleMpk(mpkPath: string | Blob, callback: IVoidCallback, errorCallback?: IErrorCallback): void
  • importModuleMpk(mpkPath: string | Blob): Promise<void>

  • Parameters

    Returns void

  • Parameters

    • mpkPath: string | Blob

    Returns Promise<void>

loadUnitById

  • loadUnitById<T>(id: string, forceRefresh: undefined | boolean, callback: ICallback<T>, errorCallback?: IErrorCallback): void
  • loadUnitById<T>(id: string, forceRefresh: undefined | boolean): Promise<T>

  • Fetches a complete unit. The result might be returned from the cache.

    Type parameters

    Parameters

    Returns void

  • Type parameters

    Parameters

    • id: string
    • forceRefresh: undefined | boolean

    Returns Promise<T>

onBuildResultEventReceived

  • onBuildResultEventReceived(callback: (buildResultEvent: IBuildResultEvent) => void): void

  • Parameters

    Returns void

onFileChangesReceived

  • onFileChangesReceived(callback: (files: string[]) => void): void

  • Parameters

    • callback: (files: string[]) => void
        • (files: string[]): void

        • Parameters

          • files: string[]

          Returns void

    Returns void

onModelChange

  • Parameters

    Returns void

onModelEventProcessed

  • Parameters

    Returns void

onWorkingCopyDataEventReceived

  • Parameters

    Returns void

putFile

  • putFile(inFilePath: string | Blob, filePath: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • putFile(inFilePath: string | Blob, filePath: string): Promise<void>

  • Parameters

    Returns void

  • Parameters

    • inFilePath: string | Blob
    • filePath: string

    Returns Promise<void>

setErrorHandler

  • Parameters

    Returns void

startReceivingModelEvents

  • startReceivingModelEvents(): void

  • Before calling this API, ensure that all handlers (i.e. onModelEventProcessed()), have been registered

    Returns void

startReceivingWorkingCopyEvents

  • startReceivingWorkingCopyEvents(): void

  • Before calling this API, ensure that all handlers (i.e. onBuildResultEventReceived() and/or onWorkingCopyDataEventReceived() ), have been registered

    Returns void

stopReceivingModelEvents

  • stopReceivingModelEvents(): void

  • Returns void

stopReceivingWorkingCopyEvents

  • stopReceivingWorkingCopyEvents(): void

  • Returns void

Static createSdkClient

  • createSdkClient(connectionConfig: ISdkConfig): ModelSdkClientImpl<IModel, Model>

  • Parameters

    Returns ModelSdkClientImpl<IModel, Model>

Generated using TypeDoc