com.fatwire.assetapi.data.search

Interface OrderBuilder<T extends OrderBuilder.OrderChainBuilder<?>>

@Exported
public interface OrderBuilder<T extends OrderBuilder.OrderChainBuilder<?>>

A builder that helps set a sort sequence into a query.

Example of an ascending order over "foo":

Orders mySortorder = OrderBuilder.orderBy("foo").build();

Example of a descending order over "foo":

Orders mySortorder = OrderBuilder.orderBy(SortDirection.DESCENDING, "foo").build();

Example of an ascending order over "foo", followed by descending order over "bar":

Orders mySortorder = OrderBuilder
                .orderBy("foo")
                .thenBy(SortDirection.DESCENDING, "bar")
                .build();

Example of an ascending order over "foo" and "bar", followed by descending order over "baz" and "zup":

Orders mySortorder = OrderBuilder
                .orderBy("foo", "bar")
                .thenBy(SortDirection.DESCENDING, "baz", "zup")
                .build();

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	OrderBuilder.OrderChainBuilder<T extends OrderBuilder.OrderChainBuilder<T>> A builder that appends an order into the ordering sequence.

Method Summary

Modifier and Type	Method and Description
Orders	build() Returns the order built by this builder.
T	orderBy(SortDirection sortDirection, String sortField, String... moreFields) Specified sorting strategy on results returned by a search.
T	orderBy(String sortField, String... moreFields) Specified sorting strategy on results returned by a search.

Method Detail

orderBy

T orderBy(String sortField,
          String... moreFields)

Specified sorting strategy on results returned by a search. This is a convenience method to invoke default ascending ordered sorting. Invoking this method is equivalent to invoking orderBy(SortDirection.ASCENDING, String, String...).

Parameters:

sortField - the first field to order by.

moreFields - optionally more fields to order by.

Returns:

the handle to this builder.

orderBy

T orderBy(SortDirection sortDirection,
          String sortField,
          String... moreFields)

Specified sorting strategy on results returned by a search.

Parameters:

sortDirection - the direction to sort.

sortField - the first field to order by.

moreFields - optionally more fields to order by.

Returns:

the handle to this builder.

See Also:

SortDirection

build

Orders build()

Returns the order built by this builder.

Returns:

the Orders instance built by this builder.