Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Configuration

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private ___adminPortNumber

___adminPortNumber: any

Private ___adminPortOnlyLocal

___adminPortOnlyLocal: any

Private ___applicationRootUrl

___applicationRootUrl: any

Private ___constantValues

___constantValues: any

Private ___customSettings

___customSettings: any

Private ___databaseName

___databaseName: any

Private ___databasePassword

___databasePassword: any

Private ___databaseType

___databaseType: any

Private ___databaseUrl

___databaseUrl: any

Private ___databaseUseIntegratedSecurity

___databaseUseIntegratedSecurity: any

Private ___databaseUserName

___databaseUserName: any

Private ___emulateCloudSecurity

___emulateCloudSecurity: any

Private ___extraJvmParameters

___extraJvmParameters: any

Private ___maxJavaHeapSize

___maxJavaHeapSize: any

Private ___name

___name: any

Private ___runtimePortNumber

___runtimePortNumber: any

Private ___runtimePortOnlyLocal

___runtimePortOnlyLocal: any

adminPortNumber

adminPortNumber: number

adminPortOnlyLocal

adminPortOnlyLocal: boolean

applicationRootUrl

applicationRootUrl: string

constantValues

constantValues: IList<ConstantValue>

container

container: AbstractElement

containerAsConfigurationSettings

containerAsConfigurationSettings: ConfigurationSettings

customSettings

customSettings: IList<CustomSetting>

databaseName

databaseName: string

databasePassword

databasePassword: string

databaseType

databaseType: DatabaseType

databaseUrl

databaseUrl: string

databaseUseIntegratedSecurity

databaseUseIntegratedSecurity: boolean

databaseUserName

databaseUserName: string

emulateCloudSecurity

emulateCloudSecurity: boolean

extraJvmParameters

extraJvmParameters: string

id

id: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

  • if false, a load is required to access these properties.

maxJavaHeapSize

maxJavaHeapSize: number

model

model: IModel

name

name: string

qualifiedName

qualifiedName: string

Calculates the fully qualified name of this element, by visiting all parents that have $isNamespace set to true.

runtimePortNumber

runtimePortNumber: number

runtimePortOnlyLocal

runtimePortOnlyLocal: boolean

typeName

typeName: string

unit

unit: ModelUnit

versionInfo

versionInfo: StructureVersionInfo

Static typeName

typeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Methods

Protected _scheduleDeltaAfterCreate

  • _scheduleDeltaAfterCreate(delta: IDelta): void

Protected _sendDeleteDelta

  • _sendDeleteDelta(): void

Protected _updateElementsContainer

  • _updateElementsContainer(unit: ModelUnit): void

  • updateElementsContainer recursively sets the unit to which this elements belong During deserialization this is not needed, but if used in the SDK, we only can set the unit once an element is actually added to the tree (buy pushing / assigning it to some part property)

    Parameters

    Returns void

Protected _updateWithJsonImpl

allProperties

deepCopyInto

delete

  • delete(): void

Protected getContainerAs

load

  • load<T>(callback: function, forceRefresh?: boolean): any
  • load<T>(): T

  • 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.

    Type parameters

    Parameters

    • callback: function
        • (elem: T): void

        • Parameters

          • elem: T

          Returns void

    • Optional forceRefresh: boolean

    Returns any

  • Type parameters

    Returns T

toJSON

  • toJSON(): Object

traverse

  • traverse(visit: function): void

traversePublicParts

  • traversePublicParts(visit: function): void

Static create

  • Creates and returns a new Configuration instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects.

    Parameters

    Returns Configuration

Static createIn

  • Creates and returns a new Configuration instance in the SDK and on the server. The new Configuration will be automatically stored in the 'configurations' property of the parent ConfigurationSettings element passed as argument.

    Parameters

    Returns Configuration

Generated using TypeDoc