io.sphere.sdk.search.model

Class MultiValueSortSearchModel<T>

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.search.model.MultiValueSortSearchModel<T>

All Implemented Interfaces:

SortSearchModel<T>

public final class MultiValueSortSearchModel<T>
extends Base

A sort model to decide the direction of a model with multiple values per resource.

See Also:

to instantiate this class

Method Summary

Modifier and Type	Method and Description
SortExpression<T>	asc() When the sort direction is ascending, the minimum value is used.
SortExpression<T>	ascWithMaxValue() Changes the default behaviour of the ascending sort by using the maximum value instead.
SortExpression<T>	by(SearchSortDirection direction)
SortExpression<T>	desc() When the direction is descending, the maximum value is used.
SortExpression<T>	descWithMinValue() Changes the default behaviour of the descending sort by using the minimum value instead.
SearchModel<T>	getSearchModel() The search model for the facet.
static <T> MultiValueSortSearchModel<T>	of(String attributePath) Creates an instance of the search model to generate multi-valued sort expressions.

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

asc

public SortExpression<T> asc()

When the sort direction is ascending, the minimum value is used.

Specified by:

asc in interface SortSearchModel<T>

Returns:

the ascending sort direction

desc

public SortExpression<T> desc()

When the direction is descending, the maximum value is used.

Specified by:

desc in interface SortSearchModel<T>

Returns:

the descending sort direction

ascWithMaxValue

public SortExpression<T> ascWithMaxValue()

Changes the default behaviour of the ascending sort by using the maximum value instead.

Returns:

the ascending sort direction using the maximum value

descWithMinValue

public SortExpression<T> descWithMinValue()

Changes the default behaviour of the descending sort by using the minimum value instead.

Returns:

the descending sort direction using the minimum value

of

public static <T> MultiValueSortSearchModel<T> of(String attributePath)

Creates an instance of the search model to generate multi-valued sort expressions.

Type Parameters:

T - type of the resource

Parameters:

attributePath - the path of the attribute as expected by Composable Commerce (e.g. "variants.attributes.color.key")

Returns:

new instance of MultiValueSortSearchModel

getSearchModel

public SearchModel<T> getSearchModel()

Description copied from interface: SortSearchModel

The search model for the facet.

Specified by:

getSearchModel in interface SortSearchModel<T>

Returns:

the facet search model

by

public SortExpression<T> by(SearchSortDirection direction)

Specified by:

by in interface SortSearchModel<T>