Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IModule

Hierarchy

Implemented by

Index

Properties

appStoreGuid

appStoreGuid: string

appStorePackageId

appStorePackageId: number

In version 8.13.0: introduced

appStoreVersion

appStoreVersion: string

appStoreVersionGuid

appStoreVersionGuid: string

container

container: IStructuralUnit

The parent unit of this unit.

containerAsFolderBase

containerAsFolderBase: IFolderBase

containerAsProject

containerAsProject: IProject

documents

documents: IList<IDocument>

domainModel

domainModel: IDomainModel

This property is required and cannot be set to null.

folders

folders: IList<IFolder>

fromAppStore

fromAppStore: boolean

id

id: string

isLoadable

isLoadable: boolean

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

isLoaded

isLoaded: boolean

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

isReadOnly

isReadOnly: boolean

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

isReusableComponent

isReusableComponent: boolean

In version 8.5.0: introduced

model

model: IModel

moduleSecurity

moduleSecurity: IModuleSecurity

This property is required and cannot be set to null.

name

name: string

sortIndex

sortIndex: number

The index of where this Module appears in the project. This property is required, and of type double. Also, its value needs to be unique among its siblings (meaning, in code: containerAsProject.modules) in the project. In other words: containerAsProject.modules.map(m => m.sortedIndex) (TS syntax) needs to be a list with unique values.

structureTypeName

structureTypeName: string

unit

Unit that owns/contains this thing.

Methods

allProperties

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

delete

  • delete(): void

loadedProperties

  • loadedProperties(): AbstractProperty<any, any>[]
  • Returns all properties when this structure is loaded, otherwise just the public properties.

    Returns AbstractProperty<any, any>[]

publicProperties

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

toJSON

traverse

  • traverse(visit: function): void
  • 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

    Returns void

traverseFind

  • traverseFind<T>(visit: function): T | null
  • Traverses this structure, returning immediately when visit returns something other than null.

    Type parameters

    • T

    Parameters

    Returns T | null

traversePublicParts

  • traversePublicParts(visit: function): void

Generated using TypeDoc