Class RuntimeSettings

Hierarchy

ProjectSettingsPart
- RuntimeSettings

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RuntimeSettings(model: AbstractModel, structureTypeName: string, id: string, isPartial: boolean, unit: ModelUnit<IAbstractModel>, container: AbstractElement<IAbstractModel, Container>): RuntimeSettings

Overrides ProjectSettingsPart.constructor
Parameters
- model: AbstractModel
- structureTypeName: string
- id: string
- isPartial: boolean
- unit: ModelUnit<IAbstractModel>
- container: AbstractElement<IAbstractModel, Container>
Returns RuntimeSettings

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "Settings$RuntimeSettings"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

afterStartupMicroflow

get afterStartupMicroflow(): null | IMicroflow
set afterStartupMicroflow(newValue: null | IMicroflow): void

Returns null | IMicroflow
Parameters
- newValue: null | IMicroflow
Returns void

afterStartupMicroflowQualifiedName

get afterStartupMicroflowQualifiedName(): null | string

Returns null | string

allowUserMultipleSessions

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

Returns boolean
Parameters
- newValue: boolean
Returns void

bcryptCost

get bcryptCost(): number
set bcryptCost(newValue: number): void

In version 9.11.0: introduced

Returns number
In version 9.11.0: introduced

Parameters
- newValue: number
Returns void

beforeShutdownMicroflow

get beforeShutdownMicroflow(): null | IMicroflow
set beforeShutdownMicroflow(newValue: null | IMicroflow): void

Returns null | IMicroflow
Parameters
- newValue: null | IMicroflow
Returns void

beforeShutdownMicroflowQualifiedName

get beforeShutdownMicroflowQualifiedName(): null | string

Returns null | string

container

get container(): TContainer

Inherited from ProjectSettingsPart.container
Returns TContainer

containerAsProjectSettings

get containerAsProjectSettings(): ProjectSettings

Overrides ProjectSettingsPart.containerAsProjectSettings
Returns ProjectSettings

defaultTimeZoneCode

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

Returns string
Parameters
- newValue: string
Returns void

enableDataStorageNewQueryHandling

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

In version 8.0.0: deleted In version 7.10.0: introduced

Returns boolean
In version 8.0.0: deleted In version 7.10.0: introduced

Parameters
- newValue: boolean
Returns void

enableDataStorageOptimisticLocking

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

In version 7.5.0: introduced

Returns boolean
In version 7.5.0: introduced

Parameters
- newValue: boolean
Returns void

enforceDataStorageUniqueness

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

In version 9.0.2: deleted In version 7.1.0: introduced

Returns boolean
In version 9.0.2: deleted In version 7.1.0: introduced

Parameters
- newValue: boolean
Returns void

firstDayOfWeek

get firstDayOfWeek(): FirstDayOfWeekEnum
set firstDayOfWeek(newValue: FirstDayOfWeekEnum): void

Returns FirstDayOfWeekEnum
Parameters
- newValue: FirstDayOfWeekEnum
Returns void

hashAlgorithm

get hashAlgorithm(): HashAlgorithmType
set hashAlgorithm(newValue: HashAlgorithmType): void

Returns HashAlgorithmType
Parameters
- newValue: HashAlgorithmType
Returns void

healthCheckMicroflow

get healthCheckMicroflow(): null | IMicroflow
set healthCheckMicroflow(newValue: null | IMicroflow): void

Returns null | IMicroflow
Parameters
- newValue: null | IMicroflow
Returns void

healthCheckMicroflowQualifiedName

get healthCheckMicroflowQualifiedName(): null | string

Returns null | string

isLoaded

get isLoaded(): boolean

Inherited from ProjectSettingsPart.isLoaded
Checks whether all attributes are available ATM
- if false, a load is required to access these properties.
Returns boolean

javaVersion

get javaVersion(): JavaVersion
set javaVersion(newValue: JavaVersion): void

In version 10.8.0: introduced

Returns JavaVersion
In version 10.8.0: introduced

Parameters
- newValue: JavaVersion
Returns void

model

get model(): TModel

Inherited from ProjectSettingsPart.model
Returns TModel

roundingMode

get roundingMode(): RoundingMode
set roundingMode(newValue: RoundingMode): void

Returns RoundingMode
Parameters
- newValue: RoundingMode
Returns void

scheduledEventTimeZoneCode

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

Returns string
Parameters
- newValue: string
Returns void

sslCertificateAlgorithm

get sslCertificateAlgorithm(): SslCertificateAlgorithm
set sslCertificateAlgorithm(newValue: SslCertificateAlgorithm): void

In version 10.21.0: introduced

Returns SslCertificateAlgorithm
In version 10.21.0: introduced

Parameters
- newValue: SslCertificateAlgorithm
Returns void

unit

get unit(): ModelUnit<IAbstractModel>

Inherited from ProjectSettingsPart.unit
Returns ModelUnit<IAbstractModel>

useDatabaseForeignKeyConstraints

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

In version 10.6.0: introduced

Returns boolean
In version 10.6.0: introduced

Parameters
- newValue: boolean
Returns void

useDeprecatedClientForWebServiceCalls

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

In version 8.0.0: deleted In version 7.15.0: introduced

Returns boolean
In version 8.0.0: deleted In version 7.15.0: introduced

Parameters
- newValue: boolean
Returns void

useOQLVersion2

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

In version 10.11.0: introduced

Returns boolean
In version 10.11.0: introduced

Parameters
- newValue: boolean
Returns void

useSystemContextForBackgroundTasks

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

In version 9.6.0: introduced

Returns boolean
In version 9.6.0: introduced

Parameters
- newValue: boolean
Returns void

Methods

allProperties

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

Inherited from ProjectSettingsPart.allProperties
Returns AbstractProperty<any, any>[]

asLoaded

asLoaded(): RuntimeSettings

Inherited from ProjectSettingsPart.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 RuntimeSettings

deepCopy

deepCopy(targetModel: IAbstractModel): RuntimeSettings

Inherited from ProjectSettingsPart.deepCopy

Creates a deep copy of this element and its children.

Parameters
- targetModel: IAbstractModel
Returns RuntimeSettings

deepCopyWithIdMap

deepCopyWithIdMap(targetModel: IAbstractModel): { copy: Element<IAbstractModel>; idMap: IMap<Structure<IAbstractModel, null | IContainer>> }

Inherited from ProjectSettingsPart.deepCopyWithIdMap

Creates a deep copy of this element and its children. Also returns a map from original to new IDs.

Parameters
- targetModel: IAbstractModel
Returns { copy: Element<IAbstractModel>; idMap: IMap<Structure<IAbstractModel, null | IContainer>> }
- copy: Element<IAbstractModel>
- idMap: IMap<Structure<IAbstractModel, null | IContainer>>

delete

delete(): void

Inherited from ProjectSettingsPart.delete

Deletes this element from the model.

Returns void

detach

detach(): RuntimeSettings

Inherited from ProjectSettingsPart.detach

Detaches this element from the model, so that it can be attached in a different place.

Returns RuntimeSettings

findElementById

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

Inherited from ProjectSettingsPart.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 ProjectSettingsPart.getContainerAs
Type parameters
- T: IContainer
Parameters
- containerType: any
Returns T

load

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

Inherited from ProjectSettingsPart.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: RuntimeSettings) => void
  - - (elem: RuntimeSettings): void
    - Parameters
      - elem: RuntimeSettings
      Returns void
- Optional forceRefresh: boolean
Returns void
Inherited from ProjectSettingsPart.load
Parameters
- Optional forceRefresh: boolean
Returns Promise<RuntimeSettings>

loadedProperties

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

Inherited from ProjectSettingsPart.loadedProperties

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

Returns AbstractProperty<any, any>[]

publicProperties

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

Inherited from ProjectSettingsPart.publicProperties
Returns AbstractProperty<any, any>[]

toJSON

toJSON(): IStructureJSON

Inherited from ProjectSettingsPart.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 IStructureJSON

traverse

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

Inherited from ProjectSettingsPart.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

Inherited from ProjectSettingsPart.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

Inherited from ProjectSettingsPart.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 create

create(model: IModel): RuntimeSettings

Creates and returns a new RuntimeSettings 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
- model: IModel
Returns RuntimeSettings

Static createIn

createIn(container: ProjectSettings): RuntimeSettings

Creates and returns a new RuntimeSettings instance in the SDK and on the server. The new RuntimeSettings will be automatically stored in the 'settingsParts' property of the parent ProjectSettings element passed as argument.

Parameters
- container: ProjectSettings
Returns RuntimeSettings

Generated using TypeDoc