Class DataAttribute

Hierarchy

DataMember
- DataAttribute

Constructors

constructor

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

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

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "WebServices$DataAttribute"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

attribute

get attribute(): null | IAttribute
set attribute(newValue: null | IAttribute): void

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

attributeByContract

get attributeByContract(): null | MsdAttribute
set attributeByContract(newValue: null | MsdAttribute): void

In version 9.0.2: deleted

Returns null | MsdAttribute
In version 9.0.2: deleted

Parameters
- newValue: null | MsdAttribute
Returns void

attributeQualifiedName

get attributeQualifiedName(): null | string

Returns null | string

container

get container(): TContainer

Inherited from DataMember.container
Returns TContainer

containerAsDataEntityBase

get containerAsDataEntityBase(): DataEntityBase

Overrides DataMember.containerAsDataEntityBase
Returns DataEntityBase

containerAsPublishedParameter

get containerAsPublishedParameter(): PublishedParameter

Inherited from DataMember.containerAsPublishedParameter
Returns PublishedParameter

containerAsPublishedResource

get containerAsPublishedResource(): PublishedResource

Inherited from DataMember.containerAsPublishedResource
Returns PublishedResource

description

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

In version 8.5.0: introduced

Returns string
In version 8.5.0: introduced

Parameters
- newValue: string
Returns void

enumerationAsString

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

In version 9.21.0: introduced

Returns boolean
In version 9.21.0: introduced

Parameters
- newValue: boolean
Returns void

exposedName

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

Inherited from DataMember.exposedName
Returns string
Inherited from DataMember.exposedName
Parameters
- newValue: string
Returns void

filterable

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

In version 9.18.0: introduced

Returns boolean
In version 9.18.0: introduced

Parameters
- newValue: boolean
Returns void

isKey

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

Inherited from DataMember.isKey
Returns boolean
Inherited from DataMember.isKey
Parameters
- newValue: boolean
Returns void

isLoaded

get isLoaded(): boolean

Inherited from DataMember.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

Inherited from DataMember.isLockedByContract

In version 9.0.2: deleted

Returns boolean
Inherited from DataMember.isLockedByContract

In version 9.0.2: deleted

Parameters
- newValue: boolean
Returns void

isNillable

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

Inherited from DataMember.isNillable
Returns boolean
Inherited from DataMember.isNillable
Parameters
- newValue: boolean
Returns void

isNillableByContract

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

Inherited from DataMember.isNillableByContract

In version 9.0.2: deleted

Returns boolean
Inherited from DataMember.isNillableByContract

In version 9.0.2: deleted

Parameters
- newValue: boolean
Returns void

isOptional

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

Inherited from DataMember.isOptional
Returns boolean
Inherited from DataMember.isOptional
Parameters
- newValue: boolean
Returns void

isOptionalByContract

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

Inherited from DataMember.isOptionalByContract

In version 9.0.2: deleted

Returns boolean
Inherited from DataMember.isOptionalByContract

In version 9.0.2: deleted

Parameters
- newValue: boolean
Returns void

model

get model(): TModel

Inherited from DataMember.model
Returns TModel

sortable

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

In version 9.18.0: introduced

Returns boolean
In version 9.18.0: introduced

Parameters
- newValue: boolean
Returns void

summary

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

In version 8.5.0: introduced

Returns string
In version 8.5.0: introduced

Parameters
- newValue: string
Returns void

unit

get unit(): ModelUnit<IAbstractModel>

Inherited from DataMember.unit
Returns ModelUnit<IAbstractModel>

Methods

allProperties

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

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

asLoaded

asLoaded(): DataAttribute

Inherited from DataMember.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 DataAttribute

deepCopy

deepCopy(targetModel: IAbstractModel): DataAttribute

Inherited from DataMember.deepCopy

Creates a deep copy of this element and its children.

Parameters
- targetModel: IAbstractModel
Returns DataAttribute

deepCopyWithIdMap

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

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

Deletes this element from the model.

Returns void

detach

detach(): DataAttribute

Inherited from DataMember.detach

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

Returns DataAttribute

findElementById

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

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

load

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

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

loadedProperties

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

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

toJSON

toJSON(): IStructureJSON

Inherited from DataMember.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 DataMember.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 DataMember.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 DataMember.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): DataAttribute

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

Static createIn

createIn(container: DataEntityBase): DataAttribute

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

Parameters
- container: DataEntityBase
Returns DataAttribute

Generated using TypeDoc