Options
All
  • Public
  • Public/Protected
  • All
Menu
deprecated

Since v1.48.0. Use EnumField instead. Represents a complex type property with a enum value.

Type parameters

  • EntityT: EntityBase

    Type of the entity the field belongs to

  • ComplexT = any

Hierarchy

  • EnumFieldBase<EntityT>
    • ComplexTypeEnumPropertyField

Index

Constructors

  • Creates an instance of ComplexTypeEnumPropertyField.

    Type parameters

    Parameters

    • fieldName: string

      Actual name of the field used in the OData request

    • fieldOf: ConstructorOrField<EntityT, ComplexT>

      The constructor of the entity or the complex type this field belongs to

    Returns ComplexTypeEnumPropertyField<EntityT, ComplexT>

Properties

_entity: EntityT
_entityConstructor: Constructable<EntityT, unknown>
_fieldName: string
_fieldOf: ConstructorOrField<EntityT, any>
_fieldOptions: Required<FieldOptions<false, false>>
fieldOf: ConstructorOrField<EntityT, ComplexT>

The constructor of the entity or the complex type this field belongs to

Methods

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

  • 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

    Copyright Ⓒ 2023 SAP SE or an SAP affiliate company. All rights reserved.