Class VersionedService

See: relevant section in reference guide

Hierarchy

Element<IModel>
- VersionedService

Constructors

constructor

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

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

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "WebServices$VersionedService"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

appServiceState

get appServiceState(): AppServiceState
set appServiceState(newValue: AppServiceState): void

In version 9.0.2: deleted

Returns AppServiceState
In version 9.0.2: deleted

Parameters
- newValue: AppServiceState
Returns void

caption

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

Returns string
Parameters
- newValue: string
Returns void

container

get container(): TContainer

Inherited from internal.Element.container
Returns TContainer

containerAsPublishedServiceBase

get containerAsPublishedServiceBase(): PublishedServiceBase

Returns PublishedServiceBase

description

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

Returns string
Parameters
- newValue: string
Returns void

documentation

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

Returns string
Parameters
- newValue: string
Returns void

enumerationsByContract

get enumerationsByContract(): null | MsdEnumerationContainer
set enumerationsByContract(newValue: null | MsdEnumerationContainer): void

In version 9.0.2: deleted

Returns null | MsdEnumerationContainer
In version 9.0.2: deleted

Parameters
- newValue: null | MsdEnumerationContainer
Returns void

headerAuthentication

get headerAuthentication(): HeaderAuthentication
set headerAuthentication(newValue: HeaderAuthentication): void

Returns HeaderAuthentication
Parameters
- newValue: HeaderAuthentication
Returns void

headerImportMapping

get headerImportMapping(): null | IImportMapping
set headerImportMapping(newValue: null | IImportMapping): void

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

headerImportMappingQualifiedName

get headerImportMappingQualifiedName(): null | string

Returns null | string

headerMicroflow

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

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

headerMicroflowQualifiedName

get headerMicroflowQualifiedName(): null | string

Returns null | string

image

get image(): null | IImage
set image(newValue: null | IImage): void

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

imageQualifiedName

get imageQualifiedName(): null | string

Returns null | string

isLoaded

get isLoaded(): boolean

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

isLockedByContract

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

In version 9.0.2: deleted

Returns boolean
In version 9.0.2: deleted

Parameters
- newValue: boolean
Returns void

model

get model(): TModel

Inherited from internal.Element.model
Returns TModel

objectHandlingBackup

get objectHandlingBackup(): ObjectHandlingBackupEnum
set objectHandlingBackup(newValue: ObjectHandlingBackupEnum): void

In version 7.17.0: introduced

Returns ObjectHandlingBackupEnum
In version 7.17.0: introduced

Parameters
- newValue: ObjectHandlingBackupEnum
Returns void

operations

get operations(): IList<PublishedOperation>

Returns IList<PublishedOperation>

optimizedXml

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

In version 7.13.0: introduced

Returns boolean
In version 7.13.0: introduced

Parameters
- newValue: boolean
Returns void

targetNamespace

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

Returns string
Parameters
- newValue: string
Returns void

unit

get unit(): ModelUnit<IAbstractModel>

Inherited from internal.Element.unit
Returns ModelUnit<IAbstractModel>

validate

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

Returns boolean
Parameters
- newValue: boolean
Returns void

versionNumber

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

Returns number
Parameters
- newValue: number
Returns void

Methods

allProperties

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

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

asLoaded

asLoaded(): VersionedService

Inherited from Element.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 VersionedService

deepCopy

deepCopy(targetModel: IAbstractModel): VersionedService

Inherited from Element.deepCopy

Creates a deep copy of this element and its children.

Parameters
- targetModel: IAbstractModel
Returns VersionedService

deepCopyWithIdMap

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

Inherited from Element.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 Element.delete

Deletes this element from the model.

Returns void

detach

detach(): VersionedService

Inherited from Element.detach

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

Returns VersionedService

findElementById

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

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

load

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

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

loadedProperties

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

Inherited from Element.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 Element.publicProperties
Returns AbstractProperty<any, any>[]

toJSON

toJSON(): IStructureJSON

Inherited from Element.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 Element.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 Element.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 Element.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): VersionedService

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
- model: IModel
Returns VersionedService

Static createIn

createIn(container: PublishedServiceBase): VersionedService

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
- container: PublishedServiceBase
Returns VersionedService

Generated using TypeDoc