com.mapinfo.geocode.api

Interface InputParam

All Superinterfaces:

Serializable

All Known Implementing Classes:

InputParameter

public interface InputParam
extends Serializable

This interface defines an input parameter for an operation supported by the geocoding service.

Method Summary

Modifier and Type	Method and Description
List<Pair<String,String>>	getAllowedValuesWithDescriptions() Get allowed values and their descriptions of input parameter.
String	getDefaultValue() Get default value of input parameter
String	getDescription() Get description of input parameterN
String	getHighBoundary() Get high boundary of input parameter, where boundary applies
String	getLowBoundary() Get low boundary of input parameter, where boundary applies
String	getName() Get name of input parameter
String	getType() Get type of input parameter
void	setAllowedValuesWithDescriptions(List<Pair<String,String>> values) Set allowed values and their descriptions of input parameter
void	setDefaultValue(String defaultValue) Set default value of input parameter
void	setDescription(String desc) Set description of input parameter
void	setHighBoundary(String highBoundary) Set high boundary of input parameter
void	setLowBoundary(String lowBoundary) Set low boundary of input parameter
void	setName(String name) Set name of input parameter
void	setType(String type) Set type of input parameter

Method Detail

getName

String getName()

Get name of input parameter

Returns:

name of input parameter

setName

void setName(String name)

Set name of input parameter

Parameters:

name - - name of input parameter

getDescription

String getDescription()

Get description of input parameterN

Returns:

description of input parameter

setDescription

void setDescription(String desc)

Set description of input parameter

Parameters:

desc - - description of input parameter

getType

String getType()

Get type of input parameter

Returns:

type of input parameter

setType

void setType(String type)

Set type of input parameter

Parameters:

type - - type of input parameter

getDefaultValue

String getDefaultValue()

Get default value of input parameter

Returns:

default value of input parameter

setDefaultValue

void setDefaultValue(String defaultValue)

Set default value of input parameter

Parameters:

defaultValue - - default value of input parameter

getLowBoundary

String getLowBoundary()

Get low boundary of input parameter, where boundary applies

Returns:

low boundary of input parameter

setLowBoundary

void setLowBoundary(String lowBoundary)

Set low boundary of input parameter

Parameters:

lowBoundary - - low boundary of input parameter

getHighBoundary

String getHighBoundary()

Get high boundary of input parameter, where boundary applies

Returns:

high boundary of input parameter

setHighBoundary

void setHighBoundary(String highBoundary)

Set high boundary of input parameter

Parameters:

highBoundary - - high boundary of input parameter

getAllowedValuesWithDescriptions

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

Get allowed values and their descriptions of input parameter. Used for the case where parameter may only be one of a specific set of values.

Returns:

allowed values and their descriptions of input parameter

setAllowedValuesWithDescriptions

void setAllowedValuesWithDescriptions(List<Pair<String,String>> values)

Set allowed values and their descriptions of input parameter

Parameters:

values - - allowed values and their descriptions of input parameter