Package com.cheetahdigital.badges.core.api

Class BadgeParams

java.lang.Object

com.cheetahdigital.corekit.rest.params.BaseParams

com.cheetahdigital.corekit.rest.params.BaseListQueryParams

com.cheetahdigital.badges.core.api.BadgeParams

All Implemented Interfaces:

android.os.Parcelable

public class BadgeParams
extends BaseListQueryParams

Class for setting the query parameter of the Badges 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	BadgeParams.Builder

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<BadgeParams>	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
BadgeParams()
BadgeParams(android.os.Parcel in)

Method Summary

Modifier and Type	Method	Description
boolean	getIsExpired()	Return the value of the expired flag
java.lang.String	getType()	Get the type of badge to retrieve.
boolean	isEarned()	Returns the value for the Earned parameter
boolean	isResultWithCategories()	Return the value for the show the categories
void	setEarned(java.lang.Boolean isEarned)	Set a filter to show Earned badges only
void	setExpired(java.lang.Boolean isExpired)	Set the flag to show expired or not expired
void	setResultWithCategories(java.lang.Boolean resultWithCategories)	Set to show the categories associated with the Badge
void	setType(java.lang.String type)	Set the type of badge to retrieve.

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<BadgeParams> CREATOR

Constructor Detail

BadgeParams

public BadgeParams(android.os.Parcel in)

BadgeParams

public BadgeParams()

Method Detail

getType

public java.lang.String getType()

Get the type of badge to retrieve.

Returns:

String type of badge

setType

public void setType(@Nullable
                    java.lang.String type)

Set the type of badge to retrieve.

Parameters:

type - type of the badge

isEarned

public boolean isEarned()

Returns the value for the Earned parameter

Returns:

boolean

setEarned

public void setEarned(@Nullable
                      java.lang.Boolean isEarned)

Set a filter to show Earned badges only

Parameters:

isEarned - true if to show earned only, otherwise, false

setResultWithCategories

public void setResultWithCategories(@Nullable
                                    java.lang.Boolean resultWithCategories)

Set to show the categories associated with the Badge

Parameters:

resultWithCategories - true to show the categories associated by the offer

isResultWithCategories

public boolean isResultWithCategories()

Return the value for the show the categories

Returns:

boolean value for show categories

setExpired

public void setExpired(@Nullable
                       java.lang.Boolean isExpired)

Set the flag to show expired or not expired

Parameters:

isExpired - true to show expired badges only, otherwise, false

getIsExpired

public boolean getIsExpired()

Return the value of the expired flag

Returns:

boolean value for the expired flag