Package com.cheetahdigital.locations.core.api

Class PlacesAPI

java.lang.Object

com.cheetahdigital.corekit.models.module.Controller

com.cheetahdigital.locations.core.api.PlacesAPI

All Implemented Interfaces:

RestController

public class PlacesAPI
extends Controller

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

Field Summary

Fields inherited from class com.cheetahdigital.corekit.models.module.Controller

STANDARD_DATE_FORMAT, TIMEZONE_DATE_FORMAT

Constructor Summary

Constructors

Constructor	Description
PlacesAPI()

Method Summary

Modifier and Type	Method	Description
void	getAddresses(PlacesParams queryParams, boolean clearCache, ListenerModel<BaseModel<Addresses>,Addresses> listener)	Gets list of addresses
void	getNearbyPlaces(PlacesParams queryParams, boolean clearCache, ListenerModel<BaseModel<Places>,Places> listener)	Get the nearby places.
void	getPlace(PlacesParams queryParams, boolean clearCache, ListenerModel<BaseModel<Place>,Place> listener)	Get the place detail by id.
void	getPlaceCategories(PlacesParams queryParams, boolean clearCache, ListenerModel<BaseModel<Categories>,Categories> listener)	Get the place categories
void	getPlaceEvents(PlacesParams queryParams, boolean clearCache, ListenerModel<BaseModel<ClientEvents>,ClientEvents> listener)	Gets the list of events for a specific Place.
void	getPlaces(PlacesParams queryParams, boolean clearCache, ListenerModel<BaseModel<Places>,Places> listener)	Gets all places
void	validateAddress(PlacesParams queryParams, PlacesFields fieldParams, ListenerModel<BaseModel<Address>,Address> listener)	Validates an address.

Methods inherited from class com.cheetahdigital.corekit.models.module.Controller

createCache, createHttpClient, createRetrofitInterface, evictAllCache, getGsonConfiguration, getRestAdapter, getTimeoutConnectionInSeconds, getTimeoutSocketInSeconds, initialize, removeResponsesFromCache

Methods inherited from class java.lang.Object

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

Constructor Detail

PlacesAPI

public PlacesAPI()

Method Detail

getPlaces

public void getPlaces(PlacesParams queryParams,
                      boolean clearCache,
                      ListenerModel<BaseModel<Places>,Places> listener)

Gets all places

Parameters:

queryParams - the PlacesParams for Places API

clearCache - clear previously stored cache

listener - listener that handles the result

getPlace

public void getPlace(PlacesParams queryParams,
                     boolean clearCache,
                     ListenerModel<BaseModel<Place>,Place> listener)

Get the place detail by id. Remember to set the id by BaseParams.setId(String).

Parameters:

queryParams - the PlacesParams for Places API

clearCache - clear previously stored cache

listener - listener that handles the result

getNearbyPlaces

public void getNearbyPlaces(PlacesParams queryParams,
                            boolean clearCache,
                            ListenerModel<BaseModel<Places>,Places> listener)

Get the nearby places. When using latitude and longitude to get the nearby places, remember to set the following (required if not using address search):

• latitude using PlacesParams.setLatitude(Double)
• longitude using PlacesParams.setLongitude(Double)

When using address search, remember to set the address using PlacesParams.setAddress(String) (required if not using lat/lon).

Parameters:

queryParams - the PlacesParams for Places API

clearCache - clear previously stored cache

listener - listener that handles the result

getPlaceCategories

public void getPlaceCategories(PlacesParams queryParams,
                               boolean clearCache,
                               ListenerModel<BaseModel<Categories>,Categories> listener)

Get the place categories

Parameters:

queryParams - the PlacesParams for Places API

clearCache - clear previously stored cache

listener - listener that handles the result

getPlaceEvents

public void getPlaceEvents(PlacesParams queryParams,
                           boolean clearCache,
                           ListenerModel<BaseModel<ClientEvents>,ClientEvents> listener)

Gets the list of events for a specific Place. Remember to set the id by BaseParams.setId(String) and the action by PlacesParams.setAction(String).

Parameters:

queryParams - the PlacesParams for Places API

clearCache - clear previously stored cache

listener - listener that handles the result

getAddresses

public void getAddresses(PlacesParams queryParams,
                         boolean clearCache,
                         ListenerModel<BaseModel<Addresses>,Addresses> listener)

Gets list of addresses

Parameters:

queryParams - the PlacesParams for Addresses API

clearCache - clear previously stored cache

listener - listener that handles the result

validateAddress

public void validateAddress(PlacesParams queryParams,
                            PlacesFields fieldParams,
                            ListenerModel<BaseModel<Address>,Address> listener)

Validates an address. Remember to set the following:

• streetAddress using PlacesFields.setStreetAddress(String)
• city using PlacesFields.setCity(String)
• state using PlacesFields.setState(String)
• countryCode using PlacesFields.setCountryCode(String)
• zipCode using PlacesFields.setZipCode(String)

Parameters:

queryParams - the PlacesParams for Addresses API

fieldParams - the PlacesFields for Addresses API

listener - listener that handles the result