com.shopify.buy3

Enum Storefront.PageSortKeys

java.lang.Object

java.lang.Enum<Storefront.PageSortKeys>

com.shopify.buy3.Storefront.PageSortKeys

All Implemented Interfaces:

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

Enclosing class:

Storefront

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

The set of valid sort keys for the Page query.

Enum Constant Summary

Enum Constants

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

Method Summary

Modifier and Type	Method and Description
static Storefront.PageSortKeys	fromGraphQl(java.lang.String value)
java.lang.String	toString()
static Storefront.PageSortKeys	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Storefront.PageSortKeys[]	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.PageSortKeys ID

Sort by the `id` value.

RELEVANCE

public static final Storefront.PageSortKeys 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.

TITLE

public static final Storefront.PageSortKeys TITLE

Sort by the `title` value.

UPDATED_AT

public static final Storefront.PageSortKeys UPDATED_AT

Sort by the `updated_at` value.

UNKNOWN_VALUE

public static final Storefront.PageSortKeys UNKNOWN_VALUE

Method Detail

values

public static Storefront.PageSortKeys[] 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.PageSortKeys c : Storefront.PageSortKeys.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.PageSortKeys 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.PageSortKeys fromGraphQl(java.lang.String value)

toString

public java.lang.String toString()

Overrides:

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