Options
All
  • Public
  • Public/Protected
  • All
Menu

Representation of a filter function, that returns a value of an orderable type. This supports int, double and decimal values.

Type parameters

Hierarchy

Index

Constructors

constructor

  • Creates an instance of OrderableFilterFunction.

    Type parameters

    Parameters

    • functionName: string

      Name of the function that returns a numeric value

    • parameters: FilterFunctionParameterType<EntityT>[]

      Representation of the parameters passed to the filter function

    • edmType: EdmTypeShared<VersionT>

      Type of the returned numeric value. This influences the formatting of the returned value.

    Returns OrderableFilterFunction<EntityT, ReturnT>

Properties

Readonly edmType

edmType: EdmTypeShared<VersionT>

Readonly functionName

functionName: string

Readonly parameters

parameters: FilterFunctionParameterType<EntityT>[]

Methods

equals

  • equals(value: ReturnT): Filter<EntityT, ReturnT>
  • Creates an instance of Filter for this filter function and the given value using the operator 'eq', i.e. ==.

    Parameters

    • value: ReturnT

      Value to be used in the filter

    Returns Filter<EntityT, ReturnT>

    The resulting filter

greaterOrEqual

  • greaterOrEqual(value: ReturnT): Filter<EntityT, ReturnT>
  • Creates an instance of Filter for this filter function and the given value using the operator 'ge', i.e. >=.

    Parameters

    • value: ReturnT

      Value to be used in the filter

    Returns Filter<EntityT, ReturnT>

    The resulting filter

greaterThan

  • greaterThan(value: ReturnT): Filter<EntityT, ReturnT>
  • Creates an instance of Filter for this filter function and the given value using the operator 'gt', i.e. >.

    Parameters

    • value: ReturnT

      Value to be used in the filter

    Returns Filter<EntityT, ReturnT>

    The resulting filter

lessOrEqual

  • lessOrEqual(value: ReturnT): Filter<EntityT, ReturnT>
  • Creates an instance of Filter for this filter function and the given value using the operator 'le', i.e. <=.

    Parameters

    • value: ReturnT

      Value to be used in the filter

    Returns Filter<EntityT, ReturnT>

    The resulting filter

lessThan

  • lessThan(value: ReturnT): Filter<EntityT, ReturnT>
  • Creates an instance of Filter for this filter function and the given value using the operator 'lt', i.e. <.

    Parameters

    • value: ReturnT

      Value to be used in the filter

    Returns Filter<EntityT, ReturnT>

    The resulting filter

notEquals

  • notEquals(value: ReturnT): Filter<EntityT, ReturnT>
  • Creates an instance of Filter for this filter function and the given value using the operator 'ne', i.e. !=.

    Parameters

    • value: ReturnT

      Value to be used in the filter

    Returns Filter<EntityT, ReturnT>

    The resulting filter

toString

  • toString(parentFieldNames?: string[]): string
  • deprecated

    Since v1.21.0. There will be no replacement. Let us know if you were using this functionality. Serializes the filter function into a string

    Parameters

    • Optional parentFieldNames: string[]

      Names of parents in case the function is part of a filter on a navigation property

    Returns string

    The filter function as string