Class CustomField<EntityT, NullableT>

Type parameters

EntityT: Entity
NullableT: boolean = false

Hierarchy

CustomField<EntityT, NullableT>
- CustomField

Index

Constructors

constructor

new CustomField<EntityT, NullableT>(fieldName: string, entityConstructor: Constructable<EntityT, unknown>, isNullable?: NullableT): CustomField<EntityT, NullableT>

Inherited from CustomFieldBase<EntityT, NullableT>.constructor
- Defined in packages/core/dist/odata-common/selectable/custom-field.d.ts:8
Type parameters
- EntityT: Entity<EntityT>
- NullableT: boolean = false
Parameters
- fieldName: string
- entityConstructor: Constructable<EntityT, unknown>
- Optional isNullable: NullableT
Returns CustomField<EntityT, NullableT>

Properties

Readonly _entity

_entity: EntityT

Readonly _entityConstructor

_entityConstructor: Constructable<EntityT, unknown>

Readonly _fieldName

_fieldName: string

Readonly _fieldOptions

_fieldOptions: Required<FieldOptions<NullableT, false>>

Protected fieldBuilder

fieldBuilder: FieldBuilder<Constructable<EntityT, unknown>>

Methods

edmBinary

edmBinary(): EdmTypeField<EntityT, "Edm.Binary", NullableT, true>

Inherited from CustomFieldBase.edmBinary
- Defined in packages/core/dist/odata-common/selectable/custom-field.d.ts:21
Returns EdmTypeField<EntityT, "Edm.Binary", NullableT, true>

edmBoolean

edmBoolean(): EdmTypeField<EntityT, "Edm.Boolean", NullableT, true>

Inherited from CustomFieldBase.edmBoolean
- Defined in packages/core/dist/odata-common/selectable/custom-field.d.ts:10
Returns EdmTypeField<EntityT, "Edm.Boolean", NullableT, true>

edmByte

edmByte(): OrderableEdmTypeField<EntityT, "Edm.Byte", NullableT, true>

Inherited from CustomFieldBase.edmByte
- Defined in packages/core/dist/odata-common/selectable/custom-field.d.ts:18
Returns OrderableEdmTypeField<EntityT, "Edm.Byte", NullableT, true>

edmDateTime

edmDateTime(): OrderableEdmTypeField<EntityT, "Edm.DateTime", NullableT, true>

- Defined in packages/core/dist/odata-v2/selectable/custom-field.d.ts:4
Returns OrderableEdmTypeField<EntityT, "Edm.DateTime", NullableT, true>

edmDateTimeOffset

edmDateTimeOffset(): OrderableEdmTypeField<EntityT, "Edm.DateTimeOffset", NullableT, true>

Inherited from CustomFieldBase.edmDateTimeOffset
- Defined in packages/core/dist/odata-common/selectable/custom-field.d.ts:20
Returns OrderableEdmTypeField<EntityT, "Edm.DateTimeOffset", NullableT, true>

edmDecimal

edmDecimal(): EdmTypeField<EntityT, "Edm.Decimal", NullableT, true>

Inherited from CustomFieldBase.edmDecimal
- Defined in packages/core/dist/odata-common/selectable/custom-field.d.ts:12
Returns EdmTypeField<EntityT, "Edm.Decimal", NullableT, true>

edmDouble

edmDouble(): OrderableEdmTypeField<EntityT, "Edm.Double", NullableT, true>

Inherited from CustomFieldBase.edmDouble
- Defined in packages/core/dist/odata-common/selectable/custom-field.d.ts:17
Returns OrderableEdmTypeField<EntityT, "Edm.Double", NullableT, true>

edmGuid

edmGuid(): EdmTypeField<EntityT, "Edm.Guid", NullableT, true>

Inherited from CustomFieldBase.edmGuid
- Defined in packages/core/dist/odata-common/selectable/custom-field.d.ts:11
Returns EdmTypeField<EntityT, "Edm.Guid", NullableT, true>

edmInt16

edmInt16(): OrderableEdmTypeField<EntityT, "Edm.Int16", NullableT, true>

Inherited from CustomFieldBase.edmInt16
- Defined in packages/core/dist/odata-common/selectable/custom-field.d.ts:13
Returns OrderableEdmTypeField<EntityT, "Edm.Int16", NullableT, true>

edmInt32

edmInt32(): OrderableEdmTypeField<EntityT, "Edm.Int32", NullableT, true>

Inherited from CustomFieldBase.edmInt32
- Defined in packages/core/dist/odata-common/selectable/custom-field.d.ts:14
Returns OrderableEdmTypeField<EntityT, "Edm.Int32", NullableT, true>

edmInt64

edmInt64(): OrderableEdmTypeField<EntityT, "Edm.Int64", NullableT, true>

Inherited from CustomFieldBase.edmInt64
- Defined in packages/core/dist/odata-common/selectable/custom-field.d.ts:15
Returns OrderableEdmTypeField<EntityT, "Edm.Int64", NullableT, true>

edmSByte

edmSByte(): OrderableEdmTypeField<EntityT, "Edm.SByte", NullableT, true>

Inherited from CustomFieldBase.edmSByte
- Defined in packages/core/dist/odata-common/selectable/custom-field.d.ts:19
Returns OrderableEdmTypeField<EntityT, "Edm.SByte", NullableT, true>

edmSingle

edmSingle(): OrderableEdmTypeField<EntityT, "Edm.Single", NullableT, true>

Inherited from CustomFieldBase.edmSingle
- Defined in packages/core/dist/odata-common/selectable/custom-field.d.ts:16
Returns OrderableEdmTypeField<EntityT, "Edm.Single", NullableT, true>

edmString

edmString(): EdmTypeField<EntityT, "Edm.String", NullableT, true>

Inherited from CustomFieldBase.edmString
- Defined in packages/core/dist/odata-common/selectable/custom-field.d.ts:9
Returns EdmTypeField<EntityT, "Edm.String", NullableT, true>

edmTime

edmTime(): OrderableEdmTypeField<EntityT, "Edm.Time", NullableT, true>

- Defined in packages/core/dist/odata-v2/selectable/custom-field.d.ts:5
Returns OrderableEdmTypeField<EntityT, "Edm.Time", NullableT, true>

fieldPath

fieldPath(): string

Inherited from CustomFieldBase.fieldPath
- Defined in packages/core/dist/odata-common/selectable/field.d.ts:64
Path to the field to be used in filter and order by queries.

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

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