org.openestate.is24.restapi

Class GIS.RegionService

java.lang.Object

org.openestate.is24.restapi.GIS.RegionService

Enclosing class:

GIS

public static final class GIS.RegionService
extends Object

Low level methods for the Region Webservice.

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

Since:

0.3

Author:

Andreas Rudolph

See Also:

Geo Information Service API

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

get

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

Call the GET method of the Region Webservice.

This method returns a specific 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 getAll(org.openestate.is24.restapi.AbstractClient, long, long)

Returns:

requested region

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

Call the GETall method of the Region Webservice.

This method returns the list of available regions for a country.

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

Returns:

list of regions

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