Class: AttributeValueCondition

$k. AttributeValueCondition

new $k.AttributeValueCondition()

Selects attributes that match a specified value with regard to a comparison operator

Methods

alternativesId() : number

Since:
  • 4.1.0
Deprecated
  • This function is not supported any more
    Returns:
    Type Description
    number

    attributeCondition() : $k.HasAttributeCondition

    Returns the attribute condition

    Since:
    • 4.1.0
    Returns:
    Type Description
    $k.HasAttributeCondition

    defaultValue() : Object

    Returns the default value. The default is used if no parameter for this condition is supplied

    Since:
    • 4.1.0
    Returns:
    Type Description
    Object

    ignoreCase() : boolean

    Returns true if equality is case insensitive. Only applies to string attributes and equality operators

    Since:
    • 4.1.0
    Returns:
    Type Description
    boolean

    operator() : string

    Returns the comparison operator

    Since:
    • 4.1.0
    Returns:
    Type Description
    string

    parameter() : string

    Returns the parameter name of the condition, if defined

    Since:
    • 4.1.0
    Returns:
    Type Description
    string

    setDefaultValue(value)

    Sets the default value. The default is used if no parameter for this condition is supplied

    Name Type Description
    value
    Since:
    • 4.1.0

    setIgnoreCase(ignoreCase)

    Set to true if equality should be insensitive

    Name Type Description
    ignoreCase boolean
    Since:
    • 4.1.0

    setOperator(operator)

    Sets the comparison operator

    Name Type Description
    operator string

    One of: "containsPhrase", "covers", "distance", "equal" (or "=="), "equalBy", "equalCardinality", "equalGeo", "equalMaxCardinality", "equalMinCardinality", "equalPresentTime", "equalsTopicOneWay", "fulltext", "greater" (or ">"), "greaterOrEqual" (or ">="), "greaterOverlaps", "greaterPresentTime", "isCoveredBy", "less" (or "<"), "lessOrEqual" (or "<="), "lessOverlaps", "lessPresentTime", "notEqual" (or "!="), "overlaps", "range", "regexEqual", "regexFulltext", "unmodifiedEqual", "words"

    Since:
    • 4.1.0

    setParameter(parameter)

    Sets the parameter name of the condition

    Name Type Description
    parameter string
    Since:
    • 4.1.0