Package com.cheetahdigital.giftcards.core.api

Class GiftcardParams

java.lang.Object

com.cheetahdigital.corekit.rest.params.BaseParams

com.cheetahdigital.corekit.rest.params.BaseListQueryParams

com.cheetahdigital.giftcards.core.api.GiftcardParams

All Implemented Interfaces:

android.os.Parcelable

public class GiftcardParams
extends BaseListQueryParams

Class for setting the query parameters of Giftcard API. All Nullable parameters means you can remove the parameter by passing a null value.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GiftcardParams.Builder	Builder class for GiftcardParams

Nested classes/interfaces inherited from class com.cheetahdigital.corekit.rest.params.BaseListQueryParams

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

Nested classes/interfaces inherited from class com.cheetahdigital.corekit.rest.params.BaseParams

BaseParams.BaseBuilder<T extends BaseParams,B extends BaseParams.BaseBuilder>

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T extends java.lang.Object>, android.os.Parcelable.Creator<T extends java.lang.Object>

Field Summary

Fields

Modifier and Type	Field	Description
static android.os.Parcelable.Creator<GiftcardParams>	CREATOR

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

mId, mQueryMap

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor	Description
GiftcardParams()	Default constructor
GiftcardParams(android.os.Parcel source)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCategory()	Returns the specific category for the gift card class
boolean	hasResultsWithCategories()	Returns the boolean value of results with categories parameter
java.lang.Boolean	isUsable()	Returns the usable flag
void	setCategory(java.lang.String category)	Set the category to show card classes with the specific category
void	setIsUsable(java.lang.Boolean isUsable)	Set the flag to show usable gift cards
void	setResultWithCategories(boolean shouldSet)	Sets results with categories to true, otherwise, false
void	setWithBalance(java.lang.Boolean withBalance)	Set the flag to show gift cards with balance
java.lang.Boolean	withBalance()	Returns the flag to show gift cards with balance

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

addCategories, addCategory, clearCategories, describeContents, getCategories, getItemsPerPage, getLayout, getPage, getSortBy, getSortOrder, removeCategory, setItemsPerPage, setLayout, setPage, setSortBy, setSortOrder, writeToParcel

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

addParam, getAccessToken, getId, getParam, getQueryMap, setAccessToken, setId

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<GiftcardParams> CREATOR

Constructor Detail

GiftcardParams

public GiftcardParams(android.os.Parcel source)

GiftcardParams

public GiftcardParams()

Default constructor

Method Detail

setIsUsable

public void setIsUsable(@Nullable
                        java.lang.Boolean isUsable)

Set the flag to show usable gift cards

Parameters:

isUsable - true to show usable gift cards

isUsable

@Nullable
public java.lang.Boolean isUsable()

Returns the usable flag

Returns:

usable flag

setWithBalance

public void setWithBalance(@Nullable
                           java.lang.Boolean withBalance)

Set the flag to show gift cards with balance

Parameters:

withBalance - true to show gift cards with balance

withBalance

@Nullable
public java.lang.Boolean withBalance()

Returns the flag to show gift cards with balance

Returns:

flag of gift cards with balance

setCategory

public void setCategory(java.lang.String category)

Set the category to show card classes with the specific category

Parameters:

category - String specific gift card class category

getCategory

public java.lang.String getCategory()

Returns the specific category for the gift card class

Returns:

String category

setResultWithCategories

public void setResultWithCategories(boolean shouldSet)

Sets results with categories to true, otherwise, false

Parameters:

shouldSet - true to enable shouldSet flag, else false

hasResultsWithCategories

public boolean hasResultsWithCategories()

Returns the boolean value of results with categories parameter

Returns:

boolean