Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PublishedOperation

Hierarchy

Implements

Index

Constructors

constructor

Properties

container

container: AbstractElement

containerAsPublishedODataService

containerAsPublishedODataService: PublishedODataService

containerAsVersionedService

containerAsVersionedService: VersionedService

dataEntity

dataEntity: DataEntity

description

description: string

documentation

documentation: string

entityExposedName

entityExposedName: string

entityExposedNameByContract

entityExposedNameByContract: string

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

microflow

microflow: IMicroflow | null

microflowQualifiedName

microflowQualifiedName: string | null

model

model: IModel

name

name: string

operationReturnType

operationReturnType: DataType

In version 7.9.0: introduced

parameters

returnType

returnType: string

The value of this property is conceptually of type dataTypes.LegacyDataType.

In version 7.9.0: deleted

returnTypeIsNillable

returnTypeIsNillable: boolean

returnTypeIsOptional

returnTypeIsOptional: boolean

returnTypeNameByContract

returnTypeNameByContract: string

returnTypeSpecificationByContract

returnTypeSpecificationByContract: string

structureTypeName

structureTypeName: string

unit

unit: ModelUnit

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

Static createIn

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

    Parameters

    Returns PublishedOperation

Generated using TypeDoc