Class StringFilterFunction<EntityT>

Representation of a filter function, that returns a value of type string.

Type Parameters

Hierarchy

  • OrderableFilterFunction<EntityT, string>
    • StringFilterFunction

Constructors

constructor

Properties

edmType functionName parameters

Methods

equals greaterOrEqual greaterThan lessOrEqual lessThan notEquals

Constructors

constructor

  • new StringFilterFunction<EntityT>(functionName, parameters): StringFilterFunction<EntityT>

  • Creates an instance of StringFilterFunction.

    Type Parameters

    Parameters

    • functionName: string

      Name of the function that returns a string value.

    • parameters: FilterFunctionParameterType<EntityT>[]

      Representation of the parameters passed to the filter function.

    Returns StringFilterFunction<EntityT>

Properties

Readonly edmType

edmType: EdmTypeShared<ODataVersionOf<EntityT>>

Readonly functionName

functionName: string

Readonly parameters

parameters: FilterFunctionParameterType<EntityT>[]

Methods

equals

  • equals(value): Filter<EntityT, any, string>

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

    Parameters

    • value: string

      Value to be used in the filter.

    Returns Filter<EntityT, any, string>

    The resulting filter.

greaterOrEqual

  • greaterOrEqual(value): Filter<EntityT, any, string>

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

    Parameters

    • value: string

      Value to be used in the filter.

    Returns Filter<EntityT, any, string>

    The resulting filter.

greaterThan

  • greaterThan(value): Filter<EntityT, any, string>

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

    Parameters

    • value: string

      Value to be used in the filter.

    Returns Filter<EntityT, any, string>

    The resulting filter.

lessOrEqual

  • lessOrEqual(value): Filter<EntityT, any, string>

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

    Parameters

    • value: string

      Value to be used in the filter.

    Returns Filter<EntityT, any, string>

    The resulting filter.

lessThan

  • lessThan(value): Filter<EntityT, any, string>

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

    Parameters

    • value: string

      Value to be used in the filter.

    Returns Filter<EntityT, any, string>

    The resulting filter.

notEquals

  • notEquals(value): Filter<EntityT, any, string>

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

    Parameters

    • value: string

      Value to be used in the filter.

    Returns Filter<EntityT, any, string>

    The resulting filter.

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

Settings

Member Visibility

Theme

On This Page

constructoredmTypefunctionNameparametersequalsgreaterOrEqualgreaterThanlessOrEquallessThannotEquals