Package com.cheetahdigital.giftcards.core.api

Class GiftcardParams.Builder

java.lang.Object

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

com.cheetahdigital.corekit.rest.params.BaseListQueryParams.BaseListQueryBuilder<GiftcardParams,GiftcardParams.Builder>

com.cheetahdigital.giftcards.core.api.GiftcardParams.Builder

Enclosing class:

GiftcardParams

public static class GiftcardParams.Builder
extends BaseListQueryParams.BaseListQueryBuilder<GiftcardParams,GiftcardParams.Builder>

Builder class for GiftcardParams

Field Summary

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

mQueryParams

Constructor Summary

Constructors

Constructor	Description
Builder()	Default constructor
Builder(GiftcardParams queryParams)	Create a builder class from an existing GiftcardParams

Method Summary

Modifier and Type	Method	Description
protected GiftcardParams	createQueryParams()	Instantiates the implementation class
GiftcardParams.Builder	setCategory(java.lang.String category)	Set the category of the gift card classes to be retrieved
GiftcardParams.Builder	setIsUsable(java.lang.Boolean isUsable)	Set the flag to show usable gift cards
GiftcardParams.Builder	setResultWithCategories(java.lang.Boolean withCategories)	Set the flag to show category in the results
GiftcardParams.Builder	setWithBalance(java.lang.Boolean withBalance)	Set the flag to show gift cards with balance

Methods inherited from class com.cheetahdigital.corekit.rest.params.BaseListQueryParams.BaseListQueryBuilder

addCategories, addCategory, setItemsPerPage, setLayout, setPage, setSortBy, setSortOrder

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

build, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(GiftcardParams queryParams)

Create a builder class from an existing GiftcardParams

Parameters:

queryParams - GiftcardParams to be reused

Builder

public Builder()

Default constructor

Method Detail

setIsUsable

public GiftcardParams.Builder setIsUsable(@Nullable
                                          java.lang.Boolean isUsable)

Set the flag to show usable gift cards

Parameters:

isUsable - true to show usable gift cards

Returns:

The Builder object to allow for chaining calls to set/add methods

setWithBalance

public GiftcardParams.Builder setWithBalance(@Nullable
                                             java.lang.Boolean withBalance)

Set the flag to show gift cards with balance

Parameters:

withBalance - true to show gift cards with balance

Returns:

The Builder object to allow for chaining calls to set/add methods

setResultWithCategories

public GiftcardParams.Builder setResultWithCategories(@Nullable
                                                      java.lang.Boolean withCategories)

Set the flag to show category in the results

Parameters:

withCategories - true to show category field in results

Returns:

The Builder object to allow chaining of calls to set/add methods

setCategory

public GiftcardParams.Builder setCategory(@Nullable
                                          java.lang.String category)

Set the category of the gift card classes to be retrieved

Parameters:

category - String internal name of the gift card class category

Returns:

The Builder object to allow chaining of calls to set/add methods

createQueryParams

protected GiftcardParams createQueryParams()

Description copied from class: BaseParams.BaseBuilder

Instantiates the implementation class

Specified by:

createQueryParams in class BaseParams.BaseBuilder<GiftcardParams,GiftcardParams.Builder>

Returns:

implementation class of BaseParams.BaseBuilder