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

constructor

• new EnumField<EntityT, DeSerializersT, EnumT, NullableT, SelectableT>(fieldName, _fieldOf, enumType?, fieldOptions?): 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.
  • Optional enumType: Record<string, EnumT>

    Enum type of the field according to the metadata description.
  • Optional fieldOptions: FieldOptions<NullableT, SelectableT>

    Optional settings for this field.

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

Readonly _fieldOf

Readonly edmType

Optional Readonly enumType

equals

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

fieldPath

• fieldPath(): string

• Gets the path to the complex type property represented by this.

  Returns string

  The path to the complex type property.

notEquals

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