Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ComplexTypeStringPropertyField<EntityT>

Represents a complex type property with a string value.

Type parameters

  • EntityT: Entity

    Type of the entity the field belongs to

Hierarchy

  • StringFieldBase<EntityT>
    • ComplexTypeStringPropertyField

Implements

Index

Constructors

constructor

  • Creates an instance of ComplexTypeStringPropertyField.

    Parameters

    • fieldName: string

      Actual name of the field used in the OData request

    • entityConstructor: Constructable<EntityT>

      Constructor type of the entity the field belongs to

    • parentTypeName: string

      Name of the parent complex type

    • edmType: EdmType

      Type of the field according to the metadata description

    Returns ComplexTypeStringPropertyField

Properties

edmType

edmType: EdmType

Type of the field according to the metadata description

entityConstructor

entityConstructor: Constructable<EntityT>

Constructor type of the entity the field belongs to

fieldName

fieldName: string

Actual name of the field used in the OData request

parentTypeName

parentTypeName: string

Name of the parent complex type

Methods

equals

  • equals(value: string): Filter<EntityT, string>
  • Creates an instance of Filter for this field and the given value using the operator 'eq', i.e. ==.

    Parameters

    • value: string

      Value to be used in the filter

    Returns Filter<EntityT, string>

    The resulting filter

fieldPath

  • fieldPath(): string
  • Path to the field to be used in filter and order by queries. Combines the parent complex type name with the field name.

    Returns string

    Path to the field to be used in filter and order by queries.

getExpands

  • getExpands(): string[]

getSelects

  • getSelects(): string[]

notEquals

  • notEquals(value: string): Filter<EntityT, string>
  • Creates an instance of Filter for this field and the given value using the operator 'ne', i.e. !=.

    Parameters

    • value: string

      Value to be used in the filter

    Returns Filter<EntityT, string>

    The resulting filter