Package com.cheetahdigital.locations.core.api

Class PlacesParams

java.lang.Object

com.cheetahdigital.corekit.rest.params.BaseParams

com.cheetahdigital.corekit.rest.params.BaseListQueryParams

com.cheetahdigital.locations.core.api.PlacesParams

All Implemented Interfaces:

android.os.Parcelable

public class PlacesParams
extends BaseListQueryParams

Class for setting the query parameters of Places 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	PlacesParams.Builder	Builder class for PlacesParams

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

Method Summary

Modifier and Type	Method	Description
void	addSubCategories(java.lang.String... subCategories)	Add sub categories to filter the list
void	addSubCategory(java.lang.String category)	Add a sub category to filter the list.
void	clearSubCategories()	Clear all the categories
int	describeContents()
java.lang.String	getAction()	Returns region transition type
java.lang.String	getAddress()	Returns place address
java.lang.Integer	getDistance()	Returns distance parameter in miles
java.lang.String	getIntegrationId()	Returns the integration id of the place
java.lang.Double	getLatitude()	Returns place latitude value
java.lang.Double	getLongitude()	Returns place longitude value
java.lang.String	getQuery()	Returns search parameter
java.util.List<java.lang.String>	getSubCategories()	Get the current list of sub categories
java.lang.String	getUnit()	Returns unit used for searching place distance
java.lang.Boolean	isWithClientEvents()	Returns the flag that was set to show places with client events
void	removeSubCategory(java.lang.String category)	Remove a sub category to the existing list of categories
void	setAction(java.lang.String action)	Set region transition type
void	setAddress(java.lang.String address)	Set place address
void	setDistance(java.lang.Integer distance)	Set distance parameter in miles
void	setIntegrationId(java.lang.String integrationId)	Set the integration id of the place
void	setLatitude(java.lang.Double lat)	Set place latitude value
void	setLongitude(java.lang.Double longitude)	Set place longitude value
void	setQuery(java.lang.String query)	Set search parameter
void	setUnit(java.lang.String unit)	Set unit used for searching place distance
void	setWithClientEvents(java.lang.Boolean withClientEvents)	Sets the flag to show places with client events
void	writeToParcel(android.os.Parcel dest, int flags)

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

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

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

Constructor Detail

PlacesParams

public PlacesParams(android.os.Parcel in)

PlacesParams

public PlacesParams()

Method Detail

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

Overrides:

describeContents in class BaseListQueryParams

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

Overrides:

writeToParcel in class BaseListQueryParams

addSubCategories

public void addSubCategories(@NonNull
                             java.lang.String... subCategories)

Add sub categories to filter the list

Parameters:

subCategories - sub categories to filter

addSubCategory

public void addSubCategory(@NonNull
                           java.lang.String category)

Add a sub category to filter the list.

Parameters:

category - category to filter.

getSubCategories

@Nullable
public java.util.List<java.lang.String> getSubCategories()

Get the current list of sub categories

Returns:

list of sub categories

removeSubCategory

public void removeSubCategory(@NonNull
                              java.lang.String category)

Remove a sub category to the existing list of categories

Parameters:

category - category to be removed

clearSubCategories

public void clearSubCategories()

Clear all the categories

getQuery

@Nullable
public java.lang.String getQuery()

Returns search parameter

Returns:

search parameter

setQuery

public void setQuery(@Nullable
                     java.lang.String query)

Set search parameter

Parameters:

query - search parameter

getLatitude

@Nullable
public java.lang.Double getLatitude()

Returns place latitude value

Returns:

place latitude value

setLatitude

public void setLatitude(@Nullable
                        java.lang.Double lat)

Set place latitude value

Parameters:

lat - place latitude value

getLongitude

@Nullable
public java.lang.Double getLongitude()

Returns place longitude value

Returns:

place longitude value

setLongitude

public void setLongitude(@Nullable
                         java.lang.Double longitude)

Set place longitude value

Parameters:

longitude - place longitude value

getDistance

@Nullable
public java.lang.Integer getDistance()

Returns distance parameter in miles

Returns:

Distance parameter in miles

setDistance

public void setDistance(@Nullable
                        java.lang.Integer distance)

Set distance parameter in miles

Parameters:

distance - Distance parameter in miles

getUnit

@Nullable
public java.lang.String getUnit()

Returns unit used for searching place distance

Returns:

unit used for searching place distance

setUnit

public void setUnit(@Nullable
                    java.lang.String unit)

Set unit used for searching place distance

Parameters:

unit - unit used for searching place distance

getAddress

@Nullable
public java.lang.String getAddress()

Returns place address

Returns:

place address

setAddress

public void setAddress(@Nullable
                       java.lang.String address)

Set place address

Parameters:

address - place address

isWithClientEvents

@Nullable
public java.lang.Boolean isWithClientEvents()

Returns the flag that was set to show places with client events

Returns:

with client events flag

setWithClientEvents

public void setWithClientEvents(@Nullable
                                java.lang.Boolean withClientEvents)

Sets the flag to show places with client events

Parameters:

withClientEvents - flag to show places with client events

getIntegrationId

@Nullable
public java.lang.String getIntegrationId()

Returns the integration id of the place

Returns:

integration id

setIntegrationId

public void setIntegrationId(@Nullable
                             java.lang.String integrationId)

Set the integration id of the place

Parameters:

integrationId - integration id of the place

getAction

@Nullable
public java.lang.String getAction()

Returns region transition type

Returns:

region transition type

setAction

public void setAction(@Nullable
                      java.lang.String action)

Set region transition type

Parameters:

action - region transition type