com.mapinfo.geocode.api

Interface CapabilitiesResponse

public interface CapabilitiesResponse

This interface defines the response to a GetCapabilities query. Depending on the parameters passed to getCapabilities, this could represent all available countries and operations, or describe a single operation of a single country.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_DESC A description of the service
static String	SERVICE_NAME The name of the service
static String	SERVICE_VERSION The service version number

Method Summary

Modifier and Type	Method and Description
String	getCoreVersion() Get the core version.
List<CustomObject>	getCustomObjects() Custom objects can be used to describe the parameters of an Operation, if it uses object beyond the defined Address, Preferences, and so forth.
List<Pair<String,String>>	getGeocoderVersions() Get the geocoder versions.
List<String>	getGeocodingEngines() Returns a list of the geocoding engines
String	getServiceDesc() Get the service description
String	getServiceName() Get the service name
List<String>	getSupportedCountries() Get the supported countries from the query.
List<Operation>	getSupportedOperations() Get the supported operations from the query.
void	setCoreVersion(String version) Set the the core version.
void	setCustomObjects(List<CustomObject> customObjects) Set the custom objects.
void	setGeocoderVersions(List<Pair<String,String>> geocoderVersions) Set the geocoder versions.
void	setGeocodingEngines(List<String> geocodeEngines) Set the Geocoding Engines.
void	setServiceDesc(String desc) Set the service description.
void	setServiceName(String name) Set the service name.
void	setSupportedCountries(List<String> countries) Set the supported countries
void	setSupportedOperations(List<Operation> operations) Set the supported operations

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

The name of the service

See Also:

Constant Field Values

SERVICE_DESC

static final String SERVICE_DESC

A description of the service

See Also:

Constant Field Values

SERVICE_VERSION

static final String SERVICE_VERSION

The service version number

See Also:

Constant Field Values

Method Detail

getServiceName

String getServiceName()

Get the service name

Returns:

the service name

setServiceName

void setServiceName(String name)

Set the service name. Setting this value has no effect on the actual service.

Parameters:

name - - the service name

getServiceDesc

String getServiceDesc()

Get the service description

Returns:

the service description

setServiceDesc

void setServiceDesc(String desc)

Set the service description. Setting this value has no effect on the actual service.

Parameters:

desc - - the service description

getCoreVersion

String getCoreVersion()

Get the core version. The "core" is the base engine used by local geocoders for all common operations.

Returns:

the core version

setCoreVersion

void setCoreVersion(String version)

Set the the core version. Setting this value has no effect on the actual core engine.

Parameters:

version - - the core version

getGeocodingEngines

List<String> getGeocodingEngines()

Returns a list of the geocoding engines

Returns:

the set of Geocoding Engines

setGeocodingEngines

void setGeocodingEngines(List<String> geocodeEngines)

Set the Geocoding Engines. Setting this value has no effect on the actual geocoding engines.

Parameters:

geocodeEngines - - the Geocoding Engines

getSupportedOperations

List<Operation> getSupportedOperations()

Get the supported operations from the query.

Returns:

list of supported operations

setSupportedOperations

void setSupportedOperations(List<Operation> operations)

Set the supported operations

Parameters:

operations - - the supported operations

getSupportedCountries

List<String> getSupportedCountries()

Get the supported countries from the query. Each country is represeneted by its ISO-3166 3-character abbreviation.

Returns:

the list of supported countries

setSupportedCountries

void setSupportedCountries(List<String> countries)

Set the supported countries

Parameters:

countries - - the supported countries

getCustomObjects

List<CustomObject> getCustomObjects()

Custom objects can be used to describe the parameters of an Operation, if it uses object beyond the defined Address, Preferences, and so forth.

Returns:

the list of custom objects

setCustomObjects

void setCustomObjects(List<CustomObject> customObjects)

Set the custom objects. Setting this value has no effect on the actual custom objects used by the service.

Parameters:

customObjects - - the custom objects

getGeocoderVersions

List<Pair<String,String>> getGeocoderVersions()

Get the geocoder versions. Each list entry contains a Pair consisting of the country name and the version of that country geocoder.

Returns:

list of geocoder versions

setGeocoderVersions

void setGeocoderVersions(List<Pair<String,String>> geocoderVersions)

Set the geocoder versions. Setting this value has no effect on the actual service.

Parameters:

geocoderVersions - - the geocoder versions