org.openestate.is24.restapi

Class GIS.CityService

java.lang.Object

org.openestate.is24.restapi.GIS.CityService

Enclosing class:

GIS

public static final class GIS.CityService
extends Object

Low level methods for the City Webservice.

The City Webservice is used in the Geo Information Service API to get informations about available cities.

Since:

0.3

Author:

Andreas Rudolph

See Also:

Geo Information Service API

Method Summary

Modifier and Type	Method and Description
static City	get(AbstractClient client, long is24ContinentId, long is24CountryId, long is24RegionId, long is24CityId) Call the GET method of the City Webservice.
static Cities	getAll(AbstractClient client, long is24ContinentId, long is24CountryId, long is24RegionId) Call the GETall method of the City Webservice.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static City get(AbstractClient client,
                       long is24ContinentId,
                       long is24CountryId,
                       long is24RegionId,
                       long is24CityId)
                throws IOException,
                       oauth.signpost.exception.OAuthException,
                       JAXBException,
                       RequestFailedException

Call the GET method of the City Webservice.

This method returns a specific city.

Parameters:

client - AbstractClient, that is used to communicate with the Webservice

is24ContinentId - ID of the continent to lookup, that was returned by GIS.ContinentService

is24CountryId - ID of the country to lookup, that was returned by GIS.CountryService

is24RegionId - ID of the region to lookup, that was returned by GIS.RegionService

is24CityId - ID of the city to lookup, that was returned by GIS.RegionService.getAll(org.openestate.is24.restapi.AbstractClient, long, long)

Returns:

requested city

Throws:

IOException - if communication with the Webservice failed

oauth.signpost.exception.OAuthException - if authorization failed

JAXBException - if XML reading / writing failed

RequestFailedException - if the Webservice did not respond with a success message

See Also:

Geo Information Service API

getAll

public static Cities getAll(AbstractClient client,
                            long is24ContinentId,
                            long is24CountryId,
                            long is24RegionId)
                     throws IOException,
                            oauth.signpost.exception.OAuthException,
                            JAXBException,
                            RequestFailedException

Call the GETall method of the City Webservice.

This method returns the list of available cities for a region.

Parameters:

client - AbstractClient, that is used to communicate with the Webservice

is24ContinentId - ID of the continent to lookup, that was returned by GIS.ContinentService

is24CountryId - ID of the country to lookup, that was returned by GIS.CountryService

is24RegionId - ID of the region to lookup, that was returned by GIS.RegionService

Returns:

list of cities

Throws:

IOException - if communication with the Webservice failed

oauth.signpost.exception.OAuthException - if authorization failed

JAXBException - if XML reading / writing failed

RequestFailedException - if the Webservice did not respond with a success message

See Also:

Geo Information Service API