Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PublishedRestResource

Hierarchy

Implements

Index

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

Accessors

container

containerAsPublishedODataService

containerAsVersionedService

countMicroflow

  • In version 9.9.0: introduced

    Returns IMicroflow | null

  • In version 9.9.0: introduced

    Parameters

    Returns any

countMicroflowQualifiedName

  • get (): string | null
  • Returns string | null

dataEntity

deletable

  • get (): boolean
  • set (newValue: boolean): any
  • In version 9.11.0: deleted In version 9.10.0: introduced

    Returns boolean

  • In version 9.11.0: deleted In version 9.10.0: introduced

    Parameters

    • newValue: boolean

    Returns any

deleteMode

  • In version 9.11.0: introduced

    Returns ChangeMode

  • In version 9.11.0: introduced

    Parameters

    Returns any

description

  • get (): string
  • set (newValue: string): any
  • In version 8.0.0: introduced

    Returns string

  • In version 8.0.0: introduced

    Parameters

    • newValue: string

    Returns any

exposedName

  • get (): string
  • set (newValue: string): any
  • In version 7.19.0: introduced

    Returns string

  • In version 7.19.0: introduced

    Parameters

    • newValue: string

    Returns any

insertMode

  • In version 9.11.0: introduced

    Returns ChangeMode

  • In version 9.11.0: introduced

    Parameters

    Returns any

insertable

  • get (): boolean
  • set (newValue: boolean): any
  • In version 9.11.0: deleted In version 9.10.0: introduced

    Returns boolean

  • In version 9.11.0: deleted In version 9.10.0: introduced

    Parameters

    • newValue: boolean

    Returns any

isLoaded

  • get (): boolean
  • Checks whether all attributes are available ATM

    • if false, a load is required to access these properties.

    Returns boolean

model

pageSize

  • get (): number
  • set (newValue: number): any
  • Returns number

  • Parameters

    • newValue: number

    Returns any

path

  • get (): string
  • set (newValue: string): any
  • Returns string

  • Parameters

    • newValue: string

    Returns any

queryMicroflow

  • In version 9.9.0: introduced

    Returns IMicroflow | null

  • In version 9.9.0: introduced

    Parameters

    Returns any

queryMicroflowQualifiedName

  • get (): string | null
  • Returns string | null

summary

  • get (): string
  • set (newValue: string): any
  • In version 8.0.0: introduced

    Returns string

  • In version 8.0.0: introduced

    Parameters

    • newValue: string

    Returns any

unit

updatable

  • get (): boolean
  • set (newValue: boolean): any
  • In version 9.11.0: deleted In version 9.4.0: introduced

    Returns boolean

  • In version 9.11.0: deleted In version 9.4.0: introduced

    Parameters

    • newValue: boolean

    Returns any

updateMicroflow

  • In version 9.11.0: deleted In version 9.9.0: introduced

    Returns IMicroflow | null

  • In version 9.11.0: deleted In version 9.9.0: introduced

    Parameters

    Returns any

updateMicroflowQualifiedName

  • get (): string | null
  • Returns string | null

updateMode

  • In version 9.11.0: introduced

    Returns ChangeMode

  • In version 9.11.0: introduced

    Parameters

    Returns any

usePaging

  • get (): boolean
  • set (newValue: boolean): any
  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns any

Methods

allProperties

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

asLoaded

  • asLoaded(): this
  • 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 this

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

  • detach(): this
  • Detaches this element from the model, so that it can be attached in a different place.

    Returns this

findElementById

Protected getContainerAs

  • getContainerAs<T>(containerType: any): T

load

  • load(callback: function, forceRefresh?: undefined | false | true): void
  • load(forceRefresh?: undefined | false | true): Promise<this>
  • 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: this): void
        • Parameters

          • elem: this

          Returns void

    • Optional forceRefresh: undefined | false | true

    Returns void

  • Parameters

    • Optional forceRefresh: undefined | false | true

    Returns Promise<this>

loadedProperties

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

publicProperties

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

toJSON

traverse

  • traverse(visit: function): void

traverseFind

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

traversePublicParts

  • traversePublicParts(visit: function): void

Static create

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

Static createIn

  • Creates and returns a new PublishedRestResource instance in the SDK and on the server. The new PublishedRestResource will be automatically stored in the 'resources' property of the parent PublishedODataService element passed as argument.

    Parameters

    Returns PublishedRestResource

Generated using TypeDoc