Class PublishedODataService

See: relevant section in reference guide

Hierarchy

Document

Implements

Index

Constructors

constructor

Methods

Constructors

constructor

new PublishedODataService(model: AbstractModel, structureTypeName: string, id: string, isPartial: boolean, container: IFolderBase): PublishedODataService

Overwrites Document.constructor

Parameters
- model: AbstractModel
- structureTypeName: string
- id: string
- isPartial: boolean
- container: IFolderBase
Returns PublishedODataService

Properties

allowedModuleRoles

allowedModuleRoles: IList<IModuleRole>

allowedModuleRolesQualifiedNames

allowedModuleRolesQualifiedNames: string[]

container

container: StructuralUnit

containerAsFolderBase

containerAsFolderBase: FolderBase

containerAsModule

containerAsModule: Module

documentation

documentation: string

excluded

excluded: boolean

id

id: string

isLoaded

isLoaded: boolean

model

model: IModel

name

name: string

namespace

namespace: string

path

path: string

publishAssociations

publishAssociations: boolean

In version 7.19.0: introduced

qualifiedName

qualifiedName: string | null

resources

resources: IList<PublishedRestResource>

structureTypeName

structureTypeName: string

unit

unit:

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Methods

allProperties

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

Implementation of IPublishedODataService.allProperties

Inherited from Structure.allProperties

Returns AbstractProperty<any, any>[]

asLoaded

asLoaded()

Implementation of IPublishedODataService.asLoaded

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

delete

delete(): void

Implementation of IPublishedODataService.delete

Inherited from ModelUnit.delete

Overwrites AbstractElement.delete

Deletes this element from the model.

Returns void

findElementById

findElementById(id: string): AbstractElement | null

Inherited from AbstractElement.findElementById

Given an element id, returns the element in this abstract element with that id, otherwise null.

Parameters
- id: string
Returns AbstractElement | null

Protected getContainerAs

getContainerAs<T>(containerType: any): T

Inherited from Structure.getContainerAs

Type parameters
- T: IContainer
Parameters
- containerType: any
Returns T

load

load(callback: function, forceRefresh?: boolean): void
load(forceRefresh?: boolean): Promise

Inherited from AbstractElement.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: function
  - - (elem: ): void
    - Parameters
      - elem:
      Returns void
- Optional forceRefresh: boolean
Returns void
Implementation of IPublishedODataService.load

Inherited from AbstractElement.load

Parameters
- Optional forceRefresh: boolean
Returns Promise

loadedProperties

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

Implementation of IPublishedODataService.loadedProperties

Inherited from Structure.loadedProperties

Returns AbstractProperty<any, any>[]

publicProperties

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

Implementation of IPublishedODataService.publicProperties

Inherited from Structure.publicProperties

Returns AbstractProperty<any, any>[]

toJSON

toJSON(): IAbstractElementJson

Implementation of IPublishedODataService.toJSON

Inherited from ModelUnit.toJSON

Overwrites Structure.toJSON

Returns IAbstractElementJson

traverse

traverse(visit: function): void

Inherited from Structure.traverse

Parameters
- visit: function
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

traverseFind

traverseFind<T>(visit: function): T | null

Inherited from Structure.traverseFind

Type parameters
- T
Parameters
- visit: function
  - - (structure: IStructure): T
    - Parameters
      - structure: IStructure
      Returns T
Returns T | null

traversePublicParts

traversePublicParts(visit: function): void

Inherited from Structure.traversePublicParts

Parameters
- visit: function
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

Static createIn

createIn(container: IFolderBase): PublishedODataService

Creates a new PublishedODataService unit in the SDK and on the server. Expects one argument, the projects.IFolderBase in which this unit is contained.

Parameters
- container: IFolderBase
Returns PublishedODataService

Generated using TypeDoc