com.shopify.buy3

Enum Storefront.ProductMediaSortKeys

java.lang.Object

java.lang.Enum<Storefront.ProductMediaSortKeys>

com.shopify.buy3.Storefront.ProductMediaSortKeys

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Storefront.ProductMediaSortKeys>

Enclosing class:

Storefront

public static enum Storefront.ProductMediaSortKeys
extends java.lang.Enum<Storefront.ProductMediaSortKeys>

The set of valid sort keys for the ProductMedia query.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ID Sort by the `id` value.
POSITION Sort by the `position` value.
RELEVANCE Sort by relevance to the search terms when the `query` parameter is specified on the connection.
UNKNOWN_VALUE

Method Summary

Modifier and Type	Method and Description
static Storefront.ProductMediaSortKeys	fromGraphQl(java.lang.String value)
java.lang.String	toString()
static Storefront.ProductMediaSortKeys	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Storefront.ProductMediaSortKeys[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ID

public static final Storefront.ProductMediaSortKeys ID

Sort by the `id` value.

POSITION

public static final Storefront.ProductMediaSortKeys POSITION

Sort by the `position` value.

RELEVANCE

public static final Storefront.ProductMediaSortKeys RELEVANCE

Sort by relevance to the search terms when the `query` parameter is specified on the connection. Don't use this sort key when no search query is specified.

UNKNOWN_VALUE

public static final Storefront.ProductMediaSortKeys UNKNOWN_VALUE

Method Detail

values

public static Storefront.ProductMediaSortKeys[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Storefront.ProductMediaSortKeys c : Storefront.ProductMediaSortKeys.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Storefront.ProductMediaSortKeys valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

fromGraphQl

public static Storefront.ProductMediaSortKeys fromGraphQl(java.lang.String value)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Storefront.ProductMediaSortKeys>