com.adobe.cq.commerce.api

Interface CommerceSort

All Known Implementing Classes:

DefaultCommerceSort

@ConsumerType
public interface CommerceSort

Interface that describes a search sort (i.e. a sortable field).

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayName()
java.lang.String	getId()
boolean	isSelected()

Method Detail

getId

java.lang.String getId()

Returns:

the unique ID of this sort, which can be passed to a search query (e.g. "name-asc")

getDisplayName

java.lang.String getDisplayName()

Returns:

the human readable name of this sort (e.g. "Name (ascending)")

isSelected

boolean isSelected()

Returns:

whether this sort is selected in the current query or not