Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VersionedService

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private ___appServiceState

___appServiceState: any

Private ___caption

___caption: any

Private ___description

___description: any

Private ___documentation

___documentation: any

Private ___enumerationsByContract

___enumerationsByContract: any

Private ___headerAuthentication

___headerAuthentication: any

Private ___headerImportMapping

___headerImportMapping: any

Private ___headerMicroflow

___headerMicroflow: any

Private ___image

___image: any

Private ___isLockedByContract

___isLockedByContract: any

Private ___operations

___operations: any

Private ___targetNamespace

___targetNamespace: any

Private ___validate

___validate: any

Private ___versionNumber

___versionNumber: any

appServiceState

appServiceState: AppServiceState

caption

caption: string

container

container: AbstractElement

containerAsPublishedServiceBase

containerAsPublishedServiceBase: PublishedServiceBase

description

description: string

documentation

documentation: string

enumerationsByContract

enumerationsByContract: MsdEnumerationContainer

headerAuthentication

headerAuthentication: HeaderAuthentication

headerImportMapping

headerImportMapping: IImportMapping

headerImportMappingQualifiedName

headerImportMappingQualifiedName: string

headerMicroflow

headerMicroflow: IMicroflow

headerMicroflowQualifiedName

headerMicroflowQualifiedName: string

id

id: string

image

image: IImage

imageQualifiedName

imageQualifiedName: string

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

operations

operations: IList<PublishedOperation>

qualifiedName

qualifiedName: string

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

targetNamespace

targetNamespace: string

typeName

typeName: string

unit

unit: ModelUnit

validate

validate: boolean

versionInfo

versionInfo: StructureVersionInfo

versionNumber

versionNumber: number

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