Class PublishedContract

In version 10.4.0: introduced

Hierarchy

Element<IModel>
- PublishedContract

Index

Constructors

constructor

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

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

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "ODataPublish$PublishedContract"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

container

get container(): TContainer

Inherited from internal.Element.container
Returns TContainer

graphQL

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

In version 10.13.0: introduced

Returns string
In version 10.13.0: introduced

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

metadata

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

Returns string
Parameters
- newValue: string
Returns void

model

get model(): TModel

Inherited from internal.Element.model
Returns TModel

openApi

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

Returns string
Parameters
- newValue: string
Returns void

serviceFeed

get serviceFeed(): odatapublish.ServiceFeed
set serviceFeed(newValue: odatapublish.ServiceFeed): void

Returns odatapublish.ServiceFeed
Parameters
- newValue: odatapublish.ServiceFeed
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(): PublishedContract

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 PublishedContract

deepCopy

deepCopy(targetModel: IAbstractModel): PublishedContract

Inherited from Element.deepCopy

Creates a deep copy of this element and its children.

Parameters
- targetModel: IAbstractModel
Returns PublishedContract

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

Inherited from Element.detach

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

Returns PublishedContract

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

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

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

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

Generated using TypeDoc