Package com.timeanddate.services

Class PlacesService

java.lang.Object

com.timeanddate.services.BaseService

com.timeanddate.services.PlacesService

public class PlacesService
extends BaseService

Author:

Cato Auestad <cato@timeanddate.com>

Field Summary

Fields inherited from class com.timeanddate.services.BaseService

Language, ServiceName, Version

Constructor Summary

Constructors

Constructor	Description
PlacesService(String accessKey, String secretKey)	The places service can be used to retrieve the list of supported places.

Method Summary

Modifier and Type	Method	Description
boolean	getIncludeCoordinates()
List<Place>	getPlaces()	Gets list of supported places
void	setIncludeCoordinates(boolean bool)

Methods inherited from class java.lang.Object

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

Constructor Details

PlacesService

public PlacesService(String accessKey,
 String secretKey)
              throws AuthenticationException

The places service can be used to retrieve the list of supported places. The ids for the places are then used in the other services to indicate the location to be queried.

Parameters:

accessKey - Access key.

secretKey - Secret key.

Throws:

AuthenticationException - Encryption of the authentication failed

Method Details

getPlaces

public List<Place> getPlaces()
                      throws ServerSideException

Gets list of supported places

Returns:

The places

Throws:

ServerSideException - The server produced an error message

setIncludeCoordinates

public void setIncludeCoordinates(boolean bool)

getIncludeCoordinates

public boolean getIncludeCoordinates()