Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TimeField<EntityT>

Represents a selectable property with a time value.

Type parameters

  • EntityT: Entity

    Type of the entity the field belongs to

Hierarchy

Implements

  • EntityIdentifiable<EntityT>

Index

Constructors

Properties

Methods

Constructors

constructor

  • new TimeField(fieldName: string, entityConstructor: Constructable<EntityT>, edmType: EdmType): TimeField

  • Creates an instance of EdmTypeField.

    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

    • edmType: EdmType

      Type of the field according to the metadata description

    Returns TimeField

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

selectable

selectable: true

Methods

equals

  • equals(value: Time): Filter<EntityT, Time>

  • Creates an instance of Filter for this field and the given value using the operator 'eq', i.e. ==.

    Parameters

    • value: Time

      Value to be used in the filter

    Returns Filter<EntityT, Time>

    The resulting filter

fieldPath

  • fieldPath(): string

  • Path to the field to be used in filter and order by queries. In most cases this will just be the fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.

    Returns string

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

greaterOrEqual

  • greaterOrEqual(value: Time): Filter<EntityT, Time>

  • Creates an instance of Filter for this field and the given value using the operator 'ge', i.e. >=.

    Parameters

    • value: Time

      Value to be used in the filter

    Returns Filter<EntityT, Time>

    The resulting filter

greaterThan

  • greaterThan(value: Time): Filter<EntityT, Time>

  • Creates an instance of Filter for this field and the given value using the operator 'gt', i.e. >.

    Parameters

    • value: Time

      Value to be used in the filter

    Returns Filter<EntityT, Time>

    The resulting filter

lessOrEqual

  • lessOrEqual(value: Time): Filter<EntityT, Time>

  • Creates an instance of Filter for this field and the given value using the operator 'le', i.e. <=.

    Parameters

    • value: Time

      Value to be used in the filter

    Returns Filter<EntityT, Time>

    The resulting filter

lessThan

  • lessThan(value: Time): Filter<EntityT, Time>

  • Creates an instance of Filter for this field and the given value using the operator 'lt', i.e. <.

    Parameters

    • value: Time

      Value to be used in the filter

    Returns Filter<EntityT, Time>

    The resulting filter

notEquals

  • notEquals(value: Time): Filter<EntityT, Time>

  • Creates an instance of Filter for this field and the given value using the operator 'ne', i.e. !=.

    Parameters

    • value: Time

      Value to be used in the filter

    Returns Filter<EntityT, Time>

    The resulting filter