Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PublishedOperation

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private ___description

___description: any

Private ___documentation

___documentation: any

Private ___entityExposedName

___entityExposedName: any

Private ___entityExposedNameByContract

___entityExposedNameByContract: any

Private ___image

___image: any

Private ___isLockedByContract

___isLockedByContract: any

Private ___microflow

___microflow: any

Private ___name

___name: any

Private ___parameters

___parameters: any

Private ___returnType

___returnType: any

Private ___returnTypeIsNillable

___returnTypeIsNillable: any

Private ___returnTypeIsOptional

___returnTypeIsOptional: any

Private ___returnTypeNameByContract

___returnTypeNameByContract: any

Private ___returnTypeSpecificationByContract

___returnTypeSpecificationByContract: any

container

container: AbstractElement

containerAsPublishedRestServiceBase

containerAsPublishedRestServiceBase: PublishedRestServiceBase

containerAsVersionedService

containerAsVersionedService: VersionedService

dataEntity

dataEntity: DataEntity

description

description: string

documentation

documentation: string

entityExposedName

entityExposedName: string

entityExposedNameByContract

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

microflow

microflow: IMicroflow

microflowQualifiedName

microflowQualifiedName: string

model

model: IModel

name

name: string

parameters

parameters: IList<PublishedParameter>

qualifiedName

qualifiedName: string

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

returnType

returnType: string

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

returnTypeIsNillable

returnTypeIsNillable: boolean

returnTypeIsOptional

returnTypeIsOptional: boolean

returnTypeNameByContract

returnTypeNameByContract: string

returnTypeSpecificationByContract

returnTypeSpecificationByContract: string

typeName

typeName: string

unit

unit: ModelUnit

versionInfo

versionInfo: StructureVersionInfo

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