Class Model

Implementation of IModel.

Hierarchy

BaseModel

Implements

Index

Constructors

constructor

Properties

Accessors

id
root

Methods

Constructors

constructor

new Model(_client: IModelServerClient, _errorHandler: IErrorCallback): Model

Inherited from AbstractModel.constructor

Parameters
- _client: IModelServerClient
- _errorHandler: IErrorCallback
Returns Model

Properties

metaModelVersion

metaModelVersion: Version

mxVersionForModel

mxVersionForModel: Version

workingCopy

workingCopy: IWorkingCopy

Accessors

id

get (): string

Inherited from AbstractModel.id

Returns string

root

get (): IProject

Overwrites AbstractModel.root

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

Returns IProject

Methods

addModuleUnitInterfaces

addModuleUnitInterfaces(structuresJson: string | IAbstractUnitJson[]): IStructuralUnit

Implementation of IModel.addModuleUnitInterfaces

Inherited from AbstractModel.addModuleUnitInterfaces

Parameters
- structuresJson: string | IAbstractUnitJson[]
Returns IStructuralUnit

allBuildingBlocks

allBuildingBlocks(): IBuildingBlock[]

Implementation of IModel.allBuildingBlocks

Inherited from BaseModel.allBuildingBlocks

Returns IBuildingBlock[]

allCodeActions

allCodeActions(): ICodeAction[]

Implementation of IModel.allCodeActions

Inherited from BaseModel.allCodeActions

Returns ICodeAction[]

allConstants

allConstants(): IConstant[]

Implementation of IModel.allConstants

Inherited from BaseModel.allConstants

Returns IConstant[]

allConsumedAppServices

allConsumedAppServices(): IConsumedAppService[]

Implementation of IModel.allConsumedAppServices

Inherited from BaseModel.allConsumedAppServices

Returns IConsumedAppService[]

allConsumedBusinessEventServices

allConsumedBusinessEventServices(): IConsumedBusinessEventService[]

Implementation of IModel.allConsumedBusinessEventServices

Inherited from BaseModel.allConsumedBusinessEventServices

Returns IConsumedBusinessEventService[]

allConsumedKafkaServices

allConsumedKafkaServices(): IConsumedKafkaService[]

Implementation of IModel.allConsumedKafkaServices

Inherited from BaseModel.allConsumedKafkaServices

Returns IConsumedKafkaService[]

allConsumedODataServices

allConsumedODataServices(): IConsumedODataService[]

Implementation of IModel.allConsumedODataServices

Inherited from BaseModel.allConsumedODataServices

Returns IConsumedODataService[]

allDataSets

allDataSets(): IDataSet[]

Implementation of IModel.allDataSets

Inherited from BaseModel.allDataSets

Returns IDataSet[]

allDocumentTemplates

allDocumentTemplates(): IDocumentTemplate[]

Implementation of IModel.allDocumentTemplates

Inherited from BaseModel.allDocumentTemplates

Returns IDocumentTemplate[]

allDocuments

allDocuments(): IDocument[]

Implementation of IModel.allDocuments

Inherited from BaseModel.allDocuments

Returns IDocument[]

allDomainModels

allDomainModels(): IDomainModel[]

Implementation of IModel.allDomainModels

Inherited from BaseModel.allDomainModels

Returns IDomainModel[]

allEnumerations

allEnumerations(): IEnumeration[]

Implementation of IModel.allEnumerations

Inherited from BaseModel.allEnumerations

Returns IEnumeration[]

allExportMappings

allExportMappings(): IExportMapping[]

Implementation of IModel.allExportMappings

Inherited from BaseModel.allExportMappings

Returns IExportMapping[]

allFolderBases

allFolderBases(): IFolderBase[]

Implementation of IModel.allFolderBases

Inherited from BaseModel.allFolderBases

Returns IFolderBase[]

allFolders

allFolders(): IFolder[]

Implementation of IModel.allFolders

Inherited from BaseModel.allFolders

Returns IFolder[]

allFormBases

allFormBases(): IFormBase[]

Implementation of IModel.allFormBases

Inherited from BaseModel.allFormBases

Returns IFormBase[]

allImageCollections

allImageCollections(): IImageCollection[]

Implementation of IModel.allImageCollections

Inherited from BaseModel.allImageCollections

Returns IImageCollection[]

allImportMappings

allImportMappings(): IImportMapping[]

Implementation of IModel.allImportMappings

Inherited from BaseModel.allImportMappings

Returns IImportMapping[]

allImportedWebServices

allImportedWebServices(): IImportedWebService[]

Implementation of IModel.allImportedWebServices

Inherited from BaseModel.allImportedWebServices

Returns IImportedWebService[]

allJavaActions

allJavaActions(): IJavaAction[]

Implementation of IModel.allJavaActions

Inherited from BaseModel.allJavaActions

Returns IJavaAction[]

allJavaScriptActions

allJavaScriptActions(): IJavaScriptAction[]

Implementation of IModel.allJavaScriptActions

Inherited from BaseModel.allJavaScriptActions

Returns IJavaScriptAction[]

allJsonStructures

allJsonStructures(): IJsonStructure[]

Implementation of IModel.allJsonStructures

Inherited from BaseModel.allJsonStructures

Returns IJsonStructure[]

allLayouts

allLayouts(): ILayout[]

Implementation of IModel.allLayouts

Inherited from BaseModel.allLayouts

Returns ILayout[]

allMappingDocuments

allMappingDocuments(): IMappingDocument[]

Implementation of IModel.allMappingDocuments

Inherited from BaseModel.allMappingDocuments

Returns IMappingDocument[]

allMenuDocuments

allMenuDocuments(): IMenuDocument[]

Implementation of IModel.allMenuDocuments

Inherited from BaseModel.allMenuDocuments

Returns IMenuDocument[]

allMessageDefinitionCollections

allMessageDefinitionCollections(): IMessageDefinitionCollection[]

Implementation of IModel.allMessageDefinitionCollections

Inherited from BaseModel.allMessageDefinitionCollections

Returns IMessageDefinitionCollection[]

allMicroflowBases

allMicroflowBases(): IMicroflowBase[]

Implementation of IModel.allMicroflowBases

Inherited from BaseModel.allMicroflowBases

Returns IMicroflowBase[]

allMicroflows

allMicroflows(): IMicroflow[]

Implementation of IModel.allMicroflows

Inherited from BaseModel.allMicroflows

Returns IMicroflow[]

allModuleDocuments

allModuleDocuments(): IModuleDocument[]

Implementation of IModel.allModuleDocuments

Inherited from BaseModel.allModuleDocuments

Returns IModuleDocument[]

allModuleSecurities

allModuleSecurities(): IModuleSecurity[]

Implementation of IModel.allModuleSecurities

Inherited from BaseModel.allModuleSecurities

Returns IModuleSecurity[]

allModuleSettings

allModuleSettings(): IModuleSettings[]

Implementation of IModel.allModuleSettings

Inherited from BaseModel.allModuleSettings

Returns IModuleSettings[]

allModules

allModules(): IModule[]

Implementation of IModel.allModules

Inherited from BaseModel.allModules

Returns IModule[]

allMxSchemas

allMxSchemas(): IMxSchema[]

Implementation of IModel.allMxSchemas

Inherited from BaseModel.allMxSchemas

Returns IMxSchema[]

allNanoflows

allNanoflows(): INanoflow[]

Implementation of IModel.allNanoflows

Inherited from BaseModel.allNanoflows

Returns INanoflow[]

allNativeLayouts

allNativeLayouts(): INativeLayout[]

Implementation of IModel.allNativeLayouts

Inherited from BaseModel.allNativeLayouts

Returns INativeLayout[]

allNativePages

allNativePages(): INativePage[]

Implementation of IModel.allNativePages

Inherited from BaseModel.allNativePages

Returns INativePage[]

allNavigationDocuments

allNavigationDocuments(): INavigationDocument[]

Implementation of IModel.allNavigationDocuments

Inherited from BaseModel.allNavigationDocuments

Returns INavigationDocument[]

allPageTemplates

allPageTemplates(): IPageTemplate[]

Implementation of IModel.allPageTemplates

Inherited from BaseModel.allPageTemplates

Returns IPageTemplate[]

allPages

allPages(): IPage[]

Implementation of IModel.allPages

Inherited from BaseModel.allPages

Returns IPage[]

allProjectConversions

allProjectConversions(): IProjectConversion[]

Implementation of IModel.allProjectConversions

Inherited from BaseModel.allProjectConversions

Returns IProjectConversion[]

allProjectDocuments

allProjectDocuments(): IProjectDocument[]

Implementation of IModel.allProjectDocuments

Inherited from BaseModel.allProjectDocuments

Returns IProjectDocument[]

allProjectSecurities

allProjectSecurities(): IProjectSecurity[]

Implementation of IModel.allProjectSecurities

Inherited from BaseModel.allProjectSecurities

Returns IProjectSecurity[]

allProjectSettings

allProjectSettings(): IProjectSettings[]

Implementation of IModel.allProjectSettings

Inherited from BaseModel.allProjectSettings

Returns IProjectSettings[]

allProjects

allProjects(): IProject[]

Implementation of IModel.allProjects

Inherited from BaseModel.allProjects

Returns IProject[]

allPublishedAppServices

allPublishedAppServices(): IPublishedAppService[]

Implementation of IModel.allPublishedAppServices

Inherited from BaseModel.allPublishedAppServices

Returns IPublishedAppService[]

allPublishedBusinessEventServices

allPublishedBusinessEventServices(): IPublishedBusinessEventService[]

Implementation of IModel.allPublishedBusinessEventServices

Inherited from BaseModel.allPublishedBusinessEventServices

Returns IPublishedBusinessEventService[]

allPublishedKafkaServices

allPublishedKafkaServices(): IPublishedKafkaService[]

Implementation of IModel.allPublishedKafkaServices

Inherited from BaseModel.allPublishedKafkaServices

Returns IPublishedKafkaService[]

allPublishedODataServices

allPublishedODataServices(): IPublishedODataService[]

Implementation of IModel.allPublishedODataServices

Inherited from BaseModel.allPublishedODataServices

Returns IPublishedODataService[]

allPublishedRestServices

allPublishedRestServices(): IPublishedRestService[]

Implementation of IModel.allPublishedRestServices

Inherited from BaseModel.allPublishedRestServices

Returns IPublishedRestService[]

allPublishedServiceBases

allPublishedServiceBases(): IPublishedServiceBase[]

Implementation of IModel.allPublishedServiceBases

Inherited from BaseModel.allPublishedServiceBases

Returns IPublishedServiceBase[]

allPublishedWebServices

allPublishedWebServices(): IPublishedWebService[]

Implementation of IModel.allPublishedWebServices

Inherited from BaseModel.allPublishedWebServices

Returns IPublishedWebService[]

allQueues

allQueues(): IQueue[]

Implementation of IModel.allQueues

Inherited from BaseModel.allQueues

Returns IQueue[]

allRegularExpressions

allRegularExpressions(): IRegularExpression[]

Implementation of IModel.allRegularExpressions

Inherited from BaseModel.allRegularExpressions

Returns IRegularExpression[]

allRemoteEntitySourceDocuments

allRemoteEntitySourceDocuments(): IRemoteEntitySourceDocument[]

Implementation of IModel.allRemoteEntitySourceDocuments

Inherited from BaseModel.allRemoteEntitySourceDocuments

Returns IRemoteEntitySourceDocument[]

allRules

allRules(): IRule[]

Implementation of IModel.allRules

Inherited from BaseModel.allRules

Returns IRule[]

allScheduledEvents

allScheduledEvents(): IScheduledEvent[]

Implementation of IModel.allScheduledEvents

Inherited from BaseModel.allScheduledEvents

Returns IScheduledEvent[]

allServerSideMicroflows

allServerSideMicroflows(): IServerSideMicroflow[]

Implementation of IModel.allServerSideMicroflows

Inherited from BaseModel.allServerSideMicroflows

Returns IServerSideMicroflow[]

allSnippets

allSnippets(): ISnippet[]

Implementation of IModel.allSnippets

Inherited from BaseModel.allSnippets

Returns ISnippet[]

allSystemTextCollections

allSystemTextCollections(): ISystemTextCollection[]

Implementation of IModel.allSystemTextCollections

Inherited from BaseModel.allSystemTextCollections

Returns ISystemTextCollection[]

allTemplateFormBases

allTemplateFormBases(): ITemplateFormBase[]

Implementation of IModel.allTemplateFormBases

Inherited from BaseModel.allTemplateFormBases

Returns ITemplateFormBase[]

allUnits

allUnits(): IAbstractUnit[]

Implementation of IModel.allUnits

Inherited from AbstractModel.allUnits

Returns a defensive collection of all units in this model.

Returns IAbstractUnit[]

allWorkflows

allWorkflows(): IWorkflow[]

Implementation of IModel.allWorkflows

Inherited from BaseModel.allWorkflows

Returns IWorkflow[]

allXmlSchemas

allXmlSchemas(): IXmlSchema[]

Implementation of IModel.allXmlSchemas

Inherited from BaseModel.allXmlSchemas

Returns IXmlSchema[]

closeConnection

closeConnection(callback: IVoidCallback, errorCallback?: IErrorCallback): void
closeConnection(): Promise<void>

Implementation of IModel.closeConnection

Inherited from AbstractModel.closeConnection

Parameters
- callback: IVoidCallback
- Optional errorCallback: IErrorCallback
Returns void
Implementation of IModel.closeConnection

Inherited from AbstractModel.closeConnection

Returns Promise<void>

createElement

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

Implementation of IModel.createElement

Inherited from BaseModel.createElement

Type parameters
- T: keyof ConcreteModelElements
Parameters
- typeName: T
Returns ConcreteModelElements[T]

deleteFile

deleteFile(filePath: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
deleteFile(filePath: string): Promise<void>

Implementation of IModel.deleteFile

Inherited from AbstractModel.deleteFile

Parameters
- filePath: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void
Implementation of IModel.deleteFile

Inherited from AbstractModel.deleteFile

Parameters
- filePath: string
Returns Promise<void>

deleteWorkingCopy

deleteWorkingCopy(callback: IVoidCallback, errorCallback?: IErrorCallback): void
deleteWorkingCopy(): Promise<void>

Implementation of IModel.deleteWorkingCopy

Inherited from AbstractModel.deleteWorkingCopy

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

Parameters
- callback: IVoidCallback
- Optional errorCallback: IErrorCallback
Returns void
Implementation of IModel.deleteWorkingCopy

Inherited from AbstractModel.deleteWorkingCopy

Returns Promise<void>

exportModuleMpk

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

Implementation of IModel.exportModuleMpk

Inherited from AbstractModel.exportModuleMpk

Parameters
- moduleId: string
- outFilePath: string
- callback: IVoidCallback
- Optional errorCallback: IErrorCallback
Returns void
Implementation of IModel.exportModuleMpk

Inherited from AbstractModel.exportModuleMpk

Parameters
- moduleId: string
- outFilePath: string
Returns Promise<void>

exportMpk

exportMpk(outFilePath: string, callback: IExportMpkCallback, errorCallback?: IErrorCallback): void
exportMpk(outFilePath: string): Promise<IExportMpkResponse>

Implementation of IModel.exportMpk

Inherited from AbstractModel.exportMpk

Parameters
- outFilePath: string
- callback: IExportMpkCallback
- Optional errorCallback: IErrorCallback
Returns void
Implementation of IModel.exportMpk

Inherited from AbstractModel.exportMpk

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[]>

Inherited from AbstractModel.filterUnitsByCustomWidgetId

Parameters
- workingCopyId: string
- widgetId: string
- callback: ICallback<string[]>
- errorCallback: IErrorCallback
Returns void
Implementation of IModel.filterUnitsByCustomWidgetId

Inherited from AbstractModel.filterUnitsByCustomWidgetId

Parameters
- workingCopyId: string
- widgetId: string
Returns Promise<string[]>

findAppServiceActionByQualifiedName

findAppServiceActionByQualifiedName(qname: string): IAppServiceAction | null

Implementation of IModel.findAppServiceActionByQualifiedName

Inherited from BaseModel.findAppServiceActionByQualifiedName

Parameters
- qname: string
Returns IAppServiceAction | null

findAppServiceActionParameterByQualifiedName

findAppServiceActionParameterByQualifiedName(qname: string): IAppServiceActionParameter | null

Implementation of IModel.findAppServiceActionParameterByQualifiedName

Inherited from BaseModel.findAppServiceActionParameterByQualifiedName

Parameters
- qname: string
Returns IAppServiceActionParameter | null

findAssociationBaseByQualifiedName

findAssociationBaseByQualifiedName(qname: string): IAssociationBase | null

Implementation of IModel.findAssociationBaseByQualifiedName

Inherited from BaseModel.findAssociationBaseByQualifiedName

Parameters
- qname: string
Returns IAssociationBase | null

findAttributeByQualifiedName

findAttributeByQualifiedName(qname: string): IAttribute | null

Implementation of IModel.findAttributeByQualifiedName

Inherited from BaseModel.findAttributeByQualifiedName

Parameters
- qname: string
Returns IAttribute | null

findConstantByQualifiedName

findConstantByQualifiedName(qname: string): IConstant | null

Implementation of IModel.findConstantByQualifiedName

Inherited from BaseModel.findConstantByQualifiedName

Parameters
- qname: string
Returns IConstant | null

findConsumedKafkaServiceByQualifiedName

findConsumedKafkaServiceByQualifiedName(qname: string): IConsumedKafkaService | null

Implementation of IModel.findConsumedKafkaServiceByQualifiedName

Inherited from BaseModel.findConsumedKafkaServiceByQualifiedName

Parameters
- qname: string
Returns IConsumedKafkaService | null

findConsumedODataServiceByQualifiedName

findConsumedODataServiceByQualifiedName(qname: string): IConsumedODataService | null

Implementation of IModel.findConsumedODataServiceByQualifiedName

Inherited from BaseModel.findConsumedODataServiceByQualifiedName

Parameters
- qname: string
Returns IConsumedODataService | null

findDataSetByQualifiedName

findDataSetByQualifiedName(qname: string): IDataSet | null

Implementation of IModel.findDataSetByQualifiedName

Inherited from BaseModel.findDataSetByQualifiedName

Parameters
- qname: string
Returns IDataSet | null

findDataSetParameterByQualifiedName

findDataSetParameterByQualifiedName(qname: string): IDataSetParameter | null

Implementation of IModel.findDataSetParameterByQualifiedName

Inherited from BaseModel.findDataSetParameterByQualifiedName

Parameters
- qname: string
Returns IDataSetParameter | null

findDocumentTemplateByQualifiedName

findDocumentTemplateByQualifiedName(qname: string): IDocumentTemplate | null

Implementation of IModel.findDocumentTemplateByQualifiedName

Inherited from BaseModel.findDocumentTemplateByQualifiedName

Parameters
- qname: string
Returns IDocumentTemplate | null

findEntityByQualifiedName

findEntityByQualifiedName(qname: string): IEntity | null

Implementation of IModel.findEntityByQualifiedName

Inherited from BaseModel.findEntityByQualifiedName

Parameters
- qname: string
Returns IEntity | null

findEnumerationByQualifiedName

findEnumerationByQualifiedName(qname: string): IEnumeration | null

Implementation of IModel.findEnumerationByQualifiedName

Inherited from BaseModel.findEnumerationByQualifiedName

Parameters
- qname: string
Returns IEnumeration | null

findEnumerationValueByQualifiedName

findEnumerationValueByQualifiedName(qname: string): IEnumerationValue | null

Implementation of IModel.findEnumerationValueByQualifiedName

Inherited from BaseModel.findEnumerationValueByQualifiedName

Parameters
- qname: string
Returns IEnumerationValue | null

findExportMappingByQualifiedName

findExportMappingByQualifiedName(qname: string): IExportMapping | null

Implementation of IModel.findExportMappingByQualifiedName

Inherited from BaseModel.findExportMappingByQualifiedName

Parameters
- qname: string
Returns IExportMapping | null

findImageByQualifiedName

findImageByQualifiedName(qname: string): IImage | null

Implementation of IModel.findImageByQualifiedName

Inherited from BaseModel.findImageByQualifiedName

Parameters
- qname: string
Returns IImage | null

findImportMappingByQualifiedName

findImportMappingByQualifiedName(qname: string): IImportMapping | null

Implementation of IModel.findImportMappingByQualifiedName

Inherited from BaseModel.findImportMappingByQualifiedName

Parameters
- qname: string
Returns IImportMapping | null

findImportedWebServiceByQualifiedName

findImportedWebServiceByQualifiedName(qname: string): IImportedWebService | null

Implementation of IModel.findImportedWebServiceByQualifiedName

Inherited from BaseModel.findImportedWebServiceByQualifiedName

Parameters
- qname: string
Returns IImportedWebService | null

findJavaActionByQualifiedName

findJavaActionByQualifiedName(qname: string): IJavaAction | null

Implementation of IModel.findJavaActionByQualifiedName

Inherited from BaseModel.findJavaActionByQualifiedName

Parameters
- qname: string
Returns IJavaAction | null

findJavaActionParameterByQualifiedName

findJavaActionParameterByQualifiedName(qname: string): IJavaActionParameter | null

Implementation of IModel.findJavaActionParameterByQualifiedName

Inherited from BaseModel.findJavaActionParameterByQualifiedName

Parameters
- qname: string
Returns IJavaActionParameter | null

findJavaScriptActionByQualifiedName

findJavaScriptActionByQualifiedName(qname: string): IJavaScriptAction | null

Implementation of IModel.findJavaScriptActionByQualifiedName

Inherited from BaseModel.findJavaScriptActionByQualifiedName

Parameters
- qname: string
Returns IJavaScriptAction | null

findJavaScriptActionParameterByQualifiedName

findJavaScriptActionParameterByQualifiedName(qname: string): IJavaScriptActionParameter | null

Implementation of IModel.findJavaScriptActionParameterByQualifiedName

Inherited from BaseModel.findJavaScriptActionParameterByQualifiedName

Parameters
- qname: string
Returns IJavaScriptActionParameter | null

findJsonStructureByQualifiedName

findJsonStructureByQualifiedName(qname: string): IJsonStructure | null

Implementation of IModel.findJsonStructureByQualifiedName

Inherited from BaseModel.findJsonStructureByQualifiedName

Parameters
- qname: string
Returns IJsonStructure | null

findLayoutByQualifiedName

findLayoutByQualifiedName(qname: string): ILayout | null

Implementation of IModel.findLayoutByQualifiedName

Inherited from BaseModel.findLayoutByQualifiedName

Parameters
- qname: string
Returns ILayout | null

findLayoutParameterByQualifiedName

findLayoutParameterByQualifiedName(qname: string): ILayoutParameter | null

Implementation of IModel.findLayoutParameterByQualifiedName

Inherited from BaseModel.findLayoutParameterByQualifiedName

Parameters
- qname: string
Returns ILayoutParameter | null

findMenuDocumentByQualifiedName

findMenuDocumentByQualifiedName(qname: string): IMenuDocument | null

Implementation of IModel.findMenuDocumentByQualifiedName

Inherited from BaseModel.findMenuDocumentByQualifiedName

Parameters
- qname: string
Returns IMenuDocument | null

findMessageDefinitionByQualifiedName

findMessageDefinitionByQualifiedName(qname: string): IMessageDefinition | null

Implementation of IModel.findMessageDefinitionByQualifiedName

Inherited from BaseModel.findMessageDefinitionByQualifiedName

Parameters
- qname: string
Returns IMessageDefinition | null

findMicroflowByQualifiedName

findMicroflowByQualifiedName(qname: string): IMicroflow | null

Implementation of IModel.findMicroflowByQualifiedName

Inherited from BaseModel.findMicroflowByQualifiedName

Parameters
- qname: string
Returns IMicroflow | null

findMicroflowParameterByQualifiedName

findMicroflowParameterByQualifiedName(qname: string): IMicroflowParameter | null

Implementation of IModel.findMicroflowParameterByQualifiedName

Inherited from BaseModel.findMicroflowParameterByQualifiedName

Parameters
- qname: string
Returns IMicroflowParameter | null

findModuleByQualifiedName

findModuleByQualifiedName(qname: string): IModule | null

Implementation of IModel.findModuleByQualifiedName

Parameters
- qname: string
Returns IModule | null

findModuleRoleByQualifiedName

findModuleRoleByQualifiedName(qname: string): IModuleRole | null

Implementation of IModel.findModuleRoleByQualifiedName

Inherited from BaseModel.findModuleRoleByQualifiedName

Parameters
- qname: string
Returns IModuleRole | null

findNanoflowByQualifiedName

findNanoflowByQualifiedName(qname: string): INanoflow | null

Implementation of IModel.findNanoflowByQualifiedName

Inherited from BaseModel.findNanoflowByQualifiedName

Parameters
- qname: string
Returns INanoflow | null

findNanoflowParameterByQualifiedName

findNanoflowParameterByQualifiedName(qname: string): INanoflowParameter | null

Implementation of IModel.findNanoflowParameterByQualifiedName

Inherited from BaseModel.findNanoflowParameterByQualifiedName

Parameters
- qname: string
Returns INanoflowParameter | null

findNativeLayoutByQualifiedName

findNativeLayoutByQualifiedName(qname: string): INativeLayout | null

Implementation of IModel.findNativeLayoutByQualifiedName

Inherited from BaseModel.findNativeLayoutByQualifiedName

Parameters
- qname: string
Returns INativeLayout | null

findNativePageByQualifiedName

findNativePageByQualifiedName(qname: string): INativePage | null

Implementation of IModel.findNativePageByQualifiedName

Inherited from BaseModel.findNativePageByQualifiedName

Parameters
- qname: string
Returns INativePage | null

findNavigationProfileByQualifiedName

findNavigationProfileByQualifiedName(qname: string): INavigationProfile | null

Implementation of IModel.findNavigationProfileByQualifiedName

Inherited from BaseModel.findNavigationProfileByQualifiedName

Parameters
- qname: string
Returns INavigationProfile | null

findPageByQualifiedName

findPageByQualifiedName(qname: string): IPage | null

Implementation of IModel.findPageByQualifiedName

Inherited from BaseModel.findPageByQualifiedName

Parameters
- qname: string
Returns IPage | null

findPageParameterByQualifiedName

findPageParameterByQualifiedName(qname: string): IPageParameter | null

Implementation of IModel.findPageParameterByQualifiedName

Inherited from BaseModel.findPageParameterByQualifiedName

Parameters
- qname: string
Returns IPageParameter | null

findQueueByQualifiedName

findQueueByQualifiedName(qname: string): IQueue | null

Implementation of IModel.findQueueByQualifiedName

Inherited from BaseModel.findQueueByQualifiedName

Parameters
- qname: string
Returns IQueue | null

findRegularExpressionByQualifiedName

findRegularExpressionByQualifiedName(qname: string): IRegularExpression | null

Implementation of IModel.findRegularExpressionByQualifiedName

Inherited from BaseModel.findRegularExpressionByQualifiedName

Parameters
- qname: string
Returns IRegularExpression | null

findRemoteEntitySourceDocumentByQualifiedName

findRemoteEntitySourceDocumentByQualifiedName(qname: string): IRemoteEntitySourceDocument | null

Implementation of IModel.findRemoteEntitySourceDocumentByQualifiedName

Inherited from BaseModel.findRemoteEntitySourceDocumentByQualifiedName

Parameters
- qname: string
Returns IRemoteEntitySourceDocument | null

findRuleByQualifiedName

findRuleByQualifiedName(qname: string): IRule | null

Implementation of IModel.findRuleByQualifiedName

Inherited from BaseModel.findRuleByQualifiedName

Parameters
- qname: string
Returns IRule | null

findRuleParameterByQualifiedName

findRuleParameterByQualifiedName(qname: string): IRuleParameter | null

Implementation of IModel.findRuleParameterByQualifiedName

Inherited from BaseModel.findRuleParameterByQualifiedName

Parameters
- qname: string
Returns IRuleParameter | null

findSnippetByQualifiedName

findSnippetByQualifiedName(qname: string): ISnippet | null

Implementation of IModel.findSnippetByQualifiedName

Inherited from BaseModel.findSnippetByQualifiedName

Parameters
- qname: string
Returns ISnippet | null

findUserRoleByQualifiedName

findUserRoleByQualifiedName(qname: string): IUserRole | null

Implementation of IModel.findUserRoleByQualifiedName

Inherited from BaseModel.findUserRoleByQualifiedName

Parameters
- qname: string
Returns IUserRole | null

findUserTaskOutcomeByQualifiedName

findUserTaskOutcomeByQualifiedName(qname: string): IUserTaskOutcome | null

Implementation of IModel.findUserTaskOutcomeByQualifiedName

Inherited from BaseModel.findUserTaskOutcomeByQualifiedName

Parameters
- qname: string
Returns IUserTaskOutcome | null

findWorkflowByQualifiedName

findWorkflowByQualifiedName(qname: string): IWorkflow | null

Implementation of IModel.findWorkflowByQualifiedName

Inherited from BaseModel.findWorkflowByQualifiedName

Parameters
- qname: string
Returns IWorkflow | null

findXmlSchemaByQualifiedName

findXmlSchemaByQualifiedName(qname: string): IXmlSchema | null

Implementation of IModel.findXmlSchemaByQualifiedName

Inherited from BaseModel.findXmlSchemaByQualifiedName

Parameters
- qname: string
Returns IXmlSchema | null

flushChanges

flushChanges(callback: IVoidCallback, errorCallback?: IErrorCallback): void
flushChanges(): Promise<void>

Implementation of IModel.flushChanges

Inherited from AbstractModel.flushChanges

Parameters
- callback: IVoidCallback
- Optional errorCallback: IErrorCallback
Returns void
Implementation of IModel.flushChanges

Inherited from AbstractModel.flushChanges

Returns Promise<void>

getFile

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

Inherited from AbstractModel.getFile

Parameters
- filePath: string
- outFilePath: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void
Implementation of IModel.getFile

Inherited from AbstractModel.getFile

Parameters
- filePath: string
- outFilePath: string
Returns Promise<void>

getFilePaths

getFilePaths(callback: ICallback<string[]>, errorCallback: IErrorCallback): void
getFilePaths(): Promise<string[]>

Implementation of IModel.getFilePaths

Inherited from AbstractModel.getFilePaths

Parameters
- callback: ICallback<string[]>
- errorCallback: IErrorCallback
Returns void
Implementation of IModel.getFilePaths

Inherited from AbstractModel.getFilePaths

Returns Promise<string[]>

getFiles

getFiles(callback: ICallback<string[]>, errorCallback: IErrorCallback): void
getFiles(): Promise<string[]>
getFiles(options: IGetFilesOptions, callback: ICallback<string[] | any>, errorCallback: IErrorCallback): void
getFiles(options: IGetFilesOptions): Promise<string[] | any>

Inherited from AbstractModel.getFiles

Parameters
- callback: ICallback<string[]>
- errorCallback: IErrorCallback
Returns void
Implementation of IModel.getFiles

Inherited from AbstractModel.getFiles

Returns Promise<string[]>
Inherited from AbstractModel.getFiles

Parameters
- options: IGetFilesOptions
- callback: ICallback<string[] | any>
- errorCallback: IErrorCallback
Returns void
Implementation of IModel.getFiles

Inherited from AbstractModel.getFiles

Parameters
- options: IGetFilesOptions
Returns Promise<string[] | any>

getLastEventId

getLastEventId(callback: ICallback<number>, errorCallback?: IErrorCallback): void
getLastEventId(): Promise<number>

Implementation of IModel.getLastEventId

Inherited from AbstractModel.getLastEventId

Parameters
- callback: ICallback<number>
- Optional errorCallback: IErrorCallback
Returns void
Implementation of IModel.getLastEventId

Inherited from AbstractModel.getLastEventId

Returns Promise<number>

handleError

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

Inherited from AbstractModel.handleError

Parameters
- message: string
- errorCallback: IErrorCallback | undefined
Returns void

importModuleMpk

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

Implementation of IModel.importModuleMpk

Inherited from AbstractModel.importModuleMpk

Parameters
- mpkPath: string | Blob
- callback: IVoidCallback
- Optional errorCallback: IErrorCallback
Returns void
Implementation of IModel.importModuleMpk

Inherited from AbstractModel.importModuleMpk

Parameters
- mpkPath: string | Blob
Returns Promise<void>

loadUnitById

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

Inherited from AbstractModel.loadUnitById

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

Type parameters
- T: IAbstractUnit
Parameters
- id: string
- forceRefresh: boolean | undefined
- callback: ICallback<T>
- Optional errorCallback: IErrorCallback
Returns void
Inherited from AbstractModel.loadUnitById

Type parameters
- T: IAbstractUnit
Parameters
- id: string
- forceRefresh: boolean | undefined
Returns Promise<T>

onBuildResultEventReceived

onBuildResultEventReceived(callback: function): void

Inherited from AbstractModel.onBuildResultEventReceived

Parameters
- callback: function
  - - (buildResultEvent: IBuildResultEvent): void
    - Parameters
      - buildResultEvent: IBuildResultEvent
      Returns void
Returns void

onFileChangesReceived

onFileChangesReceived(callback: function): void

Inherited from AbstractModel.onFileChangesReceived

Parameters
- callback: function
  - - (files: string[]): void
    - Parameters
      - files: string[]
      Returns void
Returns void

onModelChange

onModelChange(callback: IVoidCallback): void

Implementation of IModel.onModelChange

Inherited from AbstractModel.onModelChange

Parameters
- callback: IVoidCallback
Returns void

onModelEventProcessed

onModelEventProcessed(callback: IVoidCallback): void

Implementation of IModel.onModelEventProcessed

Inherited from AbstractModel.onModelEventProcessed

Parameters
- callback: IVoidCallback
Returns void

onWorkingCopyDataEventReceived

onWorkingCopyDataEventReceived(callback: function): void

Inherited from AbstractModel.onWorkingCopyDataEventReceived

Parameters
- callback: function
  - - (workingCopyDataEvent: IWorkingCopyDataEvent): void
    - Parameters
      - workingCopyDataEvent: IWorkingCopyDataEvent
      Returns void
Returns void

putFile

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

Implementation of IModel.putFile

Inherited from AbstractModel.putFile

Parameters
- inFilePath: string | Blob
- filePath: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void
Implementation of IModel.putFile

Inherited from AbstractModel.putFile

Parameters
- inFilePath: string | Blob
- filePath: string
Returns Promise<void>

setErrorHandler

setErrorHandler(callback: IErrorCallback): void

Implementation of IModel.setErrorHandler

Inherited from AbstractModel.setErrorHandler

Parameters
- callback: IErrorCallback
Returns void

startReceivingModelEvents

startReceivingModelEvents(): void

Implementation of IModel.startReceivingModelEvents

Inherited from AbstractModel.startReceivingModelEvents

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

Returns void

startReceivingWorkingCopyEvents

startReceivingWorkingCopyEvents(): void

Implementation of IModel.startReceivingWorkingCopyEvents

Inherited from AbstractModel.startReceivingWorkingCopyEvents

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

Returns void

stopReceivingModelEvents

stopReceivingModelEvents(): void

Implementation of IModel.stopReceivingModelEvents

Inherited from AbstractModel.stopReceivingModelEvents

Returns void

stopReceivingWorkingCopyEvents

stopReceivingWorkingCopyEvents(): void

Implementation of IModel.stopReceivingWorkingCopyEvents

Inherited from AbstractModel.stopReceivingWorkingCopyEvents

Returns void

Static createSdkClient

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

Parameters
- connectionConfig: ISdkConfig
Returns ModelSdkClientImpl<IModel, Model>

Generated using TypeDoc