Class EnumField<EntityT, DeSerializersT, EnumT, NullableT, SelectableT>

Represents a property with an enum value.

Type Parameters

EntityT extends EntityBase
Type of the entity the field belongs to.
DeSerializersT extends DeSerializers
EnumT extends string = string
Enum type that contains all valid enum entries for this field.
NullableT extends boolean = false
Boolean type that represents whether the field is nullable.
SelectableT extends boolean = false
Boolean type that represents whether the field is selectable.

Hierarchy (View Summary)

Field<EntityT, NullableT, SelectableT>
- EnumField

Index

Constructors

Properties

_entityConstructor _fieldName _fieldOf _fieldOptions edmType enumType?

Methods

equals fieldPath notEquals

Constructors

constructor

new EnumField<
    EntityT extends EntityBase,
    DeSerializersT extends
        DeSerializers<
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
        >,
    EnumT extends string = string,
    NullableT extends boolean = false,
    SelectableT extends boolean = false,
>(
    fieldName: string,
    _fieldOf: ConstructorOrField<EntityT>,
    enumType?: Record<string, EnumT>,
    fieldOptions?: FieldOptions<NullableT, SelectableT>,
): EnumField<EntityT, DeSerializersT, EnumT, NullableT, SelectableT>
Creates an instance of EnumField.
Type Parameters
- EntityT extends EntityBase
- DeSerializersT extends DeSerializers<
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
  >
- EnumT extends string = string
- NullableT extends boolean = false
- SelectableT extends boolean = false
Parameters
- fieldName: string
  Actual name of the field used in the OData request.
- _fieldOf: ConstructorOrField<EntityT>
  The constructor of the entity or the complex type field this field belongs to.
- OptionalenumType: Record<string, EnumT>
  Enum type of the field according to the metadata description.
- OptionalfieldOptions: FieldOptions<NullableT, SelectableT>
  Optional settings for this field.
Returns EnumField<EntityT, DeSerializersT, EnumT, NullableT, SelectableT>
Overrides Field.constructor
- Defined in packages/odata-common/dist/selectable/enum-field.d.ts:26

Properties

`Readonly`_entityConstructor

_entityConstructor: Constructable<EntityT>

`Readonly`_fieldName

_fieldName: string

`Readonly`_fieldOf

_fieldOf: ConstructorOrField<EntityT>

`Readonly`_fieldOptions

_fieldOptions: Required<FieldOptions<NullableT, SelectableT>>

`Readonly`edmType

edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4

`Optional` `Readonly`enumType

enumType?: Record<string, EnumT>

Methods

equals

equals(value: `${EnumT}`): Filter<EntityT, DeSerializersT, string>
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e. ==.
Parameters
- value: `${EnumT}`
  Value to be used in the filter.
Returns Filter<EntityT, DeSerializersT, string>
The resulting filter.
- Defined in packages/odata-common/dist/selectable/enum-field.d.ts:37

fieldPath

fieldPath(): string
Gets the path to the complex type property represented by this.

Returns string
The path to the complex type property.
Overrides Field.fieldPath
- Defined in packages/odata-common/dist/selectable/enum-field.d.ts:31

notEquals

notEquals(value: `${EnumT}`): Filter<EntityT, DeSerializersT, string>
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e. !=.
Parameters
- value: `${EnumT}`
  Value to be used in the filter.
Returns Filter<EntityT, DeSerializersT, string>
The resulting filter.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
- Defined in packages/odata-common/dist/selectable/enum-field.d.ts:43