Package com.cheetahdigital.corekit.rest.params

Class BaseListQueryParams.BaseListQueryBuilder<P extends BaseListQueryParams,B extends BaseListQueryParams.BaseListQueryBuilder>

java.lang.Object

com.cheetahdigital.corekit.rest.params.BaseParams.BaseBuilder<P,B>

com.cheetahdigital.corekit.rest.params.BaseListQueryParams.BaseListQueryBuilder<P,B>

Type Parameters:

P - the subclass of BaseListQueryParams

B - the implementation class of this class

Direct Known Subclasses:

ActivityParams.Builder, AuthenticationFieldParams.Builder, AuthenticationQueryParams.Builder, BadgeParams.Builder, BeaconFields.Builder, BeaconsParams.Builder, ChallengeParams.Builder, CodesParams.Builder, ConnectionsParams.Builder, ContentPagesParams.Builder, ContentTokenParams.Builder, EventsParams.Builder, FeedbackParams.Builder, FriendsParams.Builder, GiftcardParams.Builder, GroupsParams.Builder, HouseholdParams.Builder, InfoQueryParams.Builder, LeaderboardParams.Builder, MembersParams.Builder, MessagesParams.Builder, NewsfeedParams.Builder, OfferParams.Builder, OrderParams.Builder, PaymentParams.Builder, PlacesParams.Builder, PreferencesParams.Builder, ProductsParams.Builder, PunchcardParams.Builder, ReceiptParams.Builder, ReferralParams.Builder, RewardParams.Builder, StaticFilesParams.Builder, SummaryParams.Builder, TrackingParams.Builder, TransactionsParams.Builder, UpgradeCheckParams.Builder

Enclosing class:

BaseListQueryParams

protected abstract static class BaseListQueryParams.BaseListQueryBuilder<P extends BaseListQueryParams,B extends BaseListQueryParams.BaseListQueryBuilder>
extends BaseParams.BaseBuilder<P,B>

Abstract builder class for creating subclasses of BaseListQueryParams

Field Summary

Fields inherited from class com.cheetahdigital.corekit.rest.params.BaseParams.BaseBuilder

mQueryParams

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseListQueryBuilder()	The default constructor.
protected	BaseListQueryBuilder(P queryParams)	Create a parameter builder class using an existing parameter

Method Summary

Modifier and Type	Method	Description
B	addCategories(java.lang.String... categories)	Add categories to filter the list
B	addCategory(java.lang.String category)	Add a category to filter the list
B	setItemsPerPage(int itemsPerPage)	Set the max items per page
B	setLayout(Layout layout)	Define the layout template from the console
B	setPage(int page)	Set the offset page parameter
B	setSortBy(java.lang.String sortBy)	Set the property name that will be used to arrange the list
B	setSortOrder(SortOrder sortOrder)	Set the sort order of the list

Methods inherited from class com.cheetahdigital.corekit.rest.params.BaseParams.BaseBuilder

build, createQueryParams, setId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseListQueryBuilder

protected BaseListQueryBuilder()

The default constructor.

BaseListQueryBuilder

protected BaseListQueryBuilder(@NonNull
                               P queryParams)

Create a parameter builder class using an existing parameter

Parameters:

queryParams - the existing parameter you want to reuse

Method Detail

addCategories

public B addCategories(@NonNull
                       java.lang.String... categories)

Add categories to filter the list

Parameters:

categories - categories to filter

Returns:

the current builder

addCategory

public B addCategory(@Nullable
                     java.lang.String category)

Add a category to filter the list

Parameters:

category - category to filter

Returns:

the current builder

setLayout

public B setLayout(@Nullable
                   Layout layout)

Define the layout template from the console

Parameters:

layout - the layout template

Returns:

the current builder

setPage

public B setPage(int page)

Set the offset page parameter

Parameters:

page - offset page parameter

Returns:

the current builder

setItemsPerPage

public B setItemsPerPage(int itemsPerPage)

Set the max items per page

Parameters:

itemsPerPage - max items per page

Returns:

the current builder

setSortOrder

public B setSortOrder(@NonNull
                      SortOrder sortOrder)

Set the sort order of the list

Parameters:

sortOrder - can either be "asc" or "desc"

Returns:

the current builder

setSortBy

public B setSortBy(@Nullable
                   java.lang.String sortBy)

Set the property name that will be used to arrange the list

Parameters:

sortBy - The property name. Refer to SortBy(may not be updated).

Returns:

the current builder