Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VersionedService

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Accessors

appServiceState

caption

  • get (): string
  • set (newValue: string): any

  • Returns string

  • Parameters

    • newValue: string

    Returns any

container

containerAsPublishedServiceBase

description

  • get (): string
  • set (newValue: string): any

  • Returns string

  • Parameters

    • newValue: string

    Returns any

documentation

  • get (): string
  • set (newValue: string): any

  • Returns string

  • Parameters

    • newValue: string

    Returns any

enumerationsByContract

headerAuthentication

headerImportMapping

headerImportMappingQualifiedName

  • get (): string | null

  • Returns string | null

headerMicroflow

headerMicroflowQualifiedName

  • get (): string | null

  • Returns string | null

image

  • Returns IImage | null

  • Parameters

    Returns any

imageQualifiedName

  • get (): string | null

  • Returns string | null

isLoaded

  • get (): boolean

  • Checks whether all attributes are available ATM

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

    Returns boolean

isLockedByContract

  • get (): boolean
  • set (newValue: boolean): any

  • In version 9.0.2: deleted

    Returns boolean

  • In version 9.0.2: deleted

    Parameters

    • newValue: boolean

    Returns any

model

objectHandlingBackup

operations

optimizedXml

  • get (): boolean
  • set (newValue: boolean): any

  • In version 7.13.0: introduced

    Returns boolean

  • In version 7.13.0: introduced

    Parameters

    • newValue: boolean

    Returns any

targetNamespace

  • get (): string
  • set (newValue: string): any

  • Returns string

  • Parameters

    • newValue: string

    Returns any

unit

validate

  • get (): boolean
  • set (newValue: boolean): any

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns any

versionNumber

  • get (): number
  • set (newValue: number): any

  • Returns number

  • Parameters

    • newValue: number

    Returns any

Methods

allProperties

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

asLoaded

  • asLoaded(): this

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

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

  • detach(): this

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

    Returns this

findElementById

Protected getContainerAs

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

load

  • load(callback: function, forceRefresh?: undefined | false | true): void
  • load(forceRefresh?: undefined | false | true): Promise<this>

  • 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: this): void

        • Parameters

          • elem: this

          Returns void

    • Optional forceRefresh: undefined | false | true

    Returns void

  • Parameters

    • Optional forceRefresh: undefined | false | true

    Returns Promise<this>

loadedProperties

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

publicProperties

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

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