Class PublishedParameter

Hierarchy

Element<IModel>
- PublishedParameter

Constructors

constructor

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

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

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "WebServices$PublishedParameter"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

container

get container(): TContainer

Inherited from internal.Element.container
Returns TContainer

containerAsPublishedOperation

get containerAsPublishedOperation(): PublishedOperation

Returns PublishedOperation

dataEntity

get dataEntity(): DataEntity
set dataEntity(newValue: DataEntity): void

Returns DataEntity
Parameters
- newValue: DataEntity
Returns void

entityExposedItemName

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

Returns string
Parameters
- newValue: string
Returns void

entityExposedItemNameByContract

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

In version 9.0.2: deleted

Returns string
In version 9.0.2: deleted

Parameters
- newValue: string
Returns void

entityExposedName

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

Returns string
Parameters
- newValue: string
Returns void

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

isNillable

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

Returns boolean
Parameters
- newValue: boolean
Returns void

isOptional

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

Returns boolean
Parameters
- newValue: boolean
Returns void

isOptionalByContract

get isOptionalByContract(): boolean
set isOptionalByContract(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

parameter

get parameter(): null | IMicroflowParameter
set parameter(newValue: null | IMicroflowParameter): void

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

parameterByContract

get parameterByContract(): MsdMicroflowParameter
set parameterByContract(newValue: MsdMicroflowParameter): void

In version 9.0.2: deleted

Returns MsdMicroflowParameter
In version 9.0.2: deleted

Parameters
- newValue: MsdMicroflowParameter
Returns void

parameterQualifiedName

get parameterQualifiedName(): null | string

Returns null | string

parameterType

get parameterType(): DataType
set parameterType(newValue: DataType): void

In version 7.9.0: introduced

Returns DataType
In version 7.9.0: introduced

Parameters
- newValue: DataType
Returns void

type

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

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

In version 7.9.0: deleted

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

In version 7.9.0: deleted

Parameters
- newValue: string
Returns void

unit

get unit(): ModelUnit<IAbstractModel>

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

Methods

allProperties

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

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

asLoaded

asLoaded(): PublishedParameter

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 PublishedParameter

deepCopy

deepCopy(targetModel: IAbstractModel): PublishedParameter

Inherited from Element.deepCopy

Creates a deep copy of this element and its children.

Parameters
- targetModel: IAbstractModel
Returns PublishedParameter

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(): PublishedParameter

Inherited from Element.detach

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

Returns PublishedParameter

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: PublishedParameter) => void, forceRefresh?: boolean): void
load(forceRefresh?: boolean): Promise<PublishedParameter>

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

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): PublishedParameter

Creates and returns a new PublishedParameter 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 PublishedParameter

Static createIn

createIn(container: PublishedOperation): PublishedParameter

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

Parameters
- container: PublishedOperation
Returns PublishedParameter

Generated using TypeDoc