Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VersionedService

Hierarchy

Implements

Index

Constructors

constructor

Properties

appServiceState

appServiceState: AppServiceState

caption

caption: string

container

container: AbstractElement

containerAsPublishedServiceBase

containerAsPublishedServiceBase: PublishedServiceBase

description

description: string

documentation

documentation: string

enumerationsByContract

enumerationsByContract: MsdEnumerationContainer | null

headerAuthentication

headerAuthentication: HeaderAuthentication

headerImportMapping

headerImportMapping: IImportMapping | null

headerImportMappingQualifiedName

headerImportMappingQualifiedName: string | null

headerMicroflow

headerMicroflow: IMicroflow | null

headerMicroflowQualifiedName

headerMicroflowQualifiedName: string | null

id

id: string

image

image: IImage | null

imageQualifiedName

imageQualifiedName: string | null

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

isLockedByContract

isLockedByContract: boolean

model

model: IModel

objectHandlingBackup

objectHandlingBackup: ObjectHandlingBackupEnum

In version 7.17.0: introduced

operations

optimizedXml

optimizedXml: boolean

In version 7.13.0: introduced

structureTypeName

structureTypeName: string

targetNamespace

targetNamespace: string

unit

unit: ModelUnit

validate

validate: boolean

versionNumber

versionNumber: number

Static structureTypeName

structureTypeName: string

Static versionInfo

Methods

allProperties

asLoaded

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

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

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

findElementById

Protected getContainerAs

  • getContainerAs<T>(containerType: any): T

load

  • load(callback: function, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise
  • 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: function
        • (elem: ): void
        • Parameters

          • elem:

          Returns void

    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise

loadedProperties

publicProperties

toJSON

traverse

  • traverse(visit: function): void

traverseFind

  • traverseFind<T>(visit: function): T | null

traversePublicParts

  • traversePublicParts(visit: function): void

Static create

  • Creates and returns a new VersionedService 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 VersionedService

Static createIn

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

    Parameters

    Returns VersionedService

Generated using TypeDoc