Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

Properties

id: string
structureTypeName: string
structureTypeName: string = "DataSets$DataSetObjectConstraint"
versionInfo: StructureVersionInfo = ...

Accessors

  • get constraint(): string
  • set constraint(newValue: string): void
  • The value of this property is conceptually of type xPathConstraints.XPathConstraint.

    Returns string

  • The value of this property is conceptually of type xPathConstraints.XPathConstraint.

    Parameters

    • newValue: string

    Returns void

  • get container(): TContainer
  • Returns TContainer

  • Returns DataSetParameter

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

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

    Returns boolean

  • get model(): TModel
  • Returns TModel

  • get name(): string
  • set name(newValue: string): void
  • Returns string

  • Parameters

    • newValue: string

    Returns void

Methods

  • 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 DataSetObjectConstraint

  • delete(): void
  • getContainerAs<T>(containerType: any): T
  • toJSON(): IStructureJSON
  • 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(visit: (structure: IStructure) => void): void
  • 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

    Returns void

  • traverseFind<T>(visit: (structure: IStructure) => T): null | T
  • traversePublicParts(visit: (structure: IStructure) => void): void
  • Creates and returns a new DataSetObjectConstraint 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 DataSetObjectConstraint

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

    Parameters

    Returns DataSetObjectConstraint

Generated using TypeDoc