com.mapinfo.geocode.api

Interface Operation

All Known Implementing Classes:

GeocodeOperation

public interface Operation

Describes a method of the geocoding engine, specifying required and optional input parameters and the output object structure.

Method Summary

Modifier and Type	Method and Description
List<SupportLevelDescriptor>	getLevelsOfSupport() Returns a structure which describes what countries support the operation, along with any custom modifications for that country
String	getName() The name of the operation
List<InputParam>	getOptionalInput() List of any optional input objects for the operation
List<OutputParam>	getOutput() List of the output objects for the operation
List<InputParam>	getRequiredInput() List of any required input objects for the operation
void	setLevelsOfSupport(List<SupportLevelDescriptor> levelsOfSupport) Local support information
void	setName(String name) Name of the operation
void	setOptionalInput(List<InputParam> params) The optional input
void	setOutput(List<OutputParam> params) The output objects
void	setRequiredInput(List<InputParam> params) The required input

Method Detail

getName

String getName()

The name of the operation

Returns:

name of the operation

setName

void setName(String name)

Name of the operation

Parameters:

name - name of the operation

getRequiredInput

List<InputParam> getRequiredInput()

List of any required input objects for the operation

Returns:

required input objects for the operation

setRequiredInput

void setRequiredInput(List<InputParam> params)

The required input

Parameters:

params - required input objects

getOptionalInput

List<InputParam> getOptionalInput()

List of any optional input objects for the operation

Returns:

optional input objects for the operation

setOptionalInput

void setOptionalInput(List<InputParam> params)

The optional input

Parameters:

params - optional input objects

getOutput

List<OutputParam> getOutput()

List of the output objects for the operation

Returns:

ouput objects for the operation

setOutput

void setOutput(List<OutputParam> params)

The output objects

Parameters:

params - output objects

getLevelsOfSupport

List<SupportLevelDescriptor> getLevelsOfSupport()

Returns a structure which describes what countries support the operation, along with any custom modifications for that country

Returns:

country support information

setLevelsOfSupport

void setLevelsOfSupport(List<SupportLevelDescriptor> levelsOfSupport)

Local support information

Parameters:

levelsOfSupport - local support information