org.openestate.is24.restapi

Class GIS.QuarterService

java.lang.Object

org.openestate.is24.restapi.GIS.QuarterService

Enclosing class:

GIS

public static final class GIS.QuarterService
extends Object

Low level methods for the Quarter Webservice.

The Quarter Webservice is used in the Geo Information Service API to get informations about available city quarters.

Since:

0.3

Author:

Andreas Rudolph

See Also:

Geo Information Service API

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

get

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

Call the GET method of the Quarter Webservice.

This method returns a specific city quarter.

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.CityService

is24QuarterId - ID of the quarter to lookup, that was returned by GIS.CityService.getAll(org.openestate.is24.restapi.AbstractClient, long, long, long)

Returns:

requested quarter

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 Quarters getAll(AbstractClient client,
                              long is24ContinentId,
                              long is24CountryId,
                              long is24RegionId,
                              long is24CityId)
                       throws IOException,
                              oauth.signpost.exception.OAuthException,
                              JAXBException,
                              RequestFailedException

Call the GETall method of the Quarter Webservice.

This method returns the list of available quarters for a 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.CityService

Returns:

list of quarters

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