SupportLevelDescriptor (geocodingservices - geocoding-api 5.1.854 API)

All Known Implementing Classes:

SupportLevel
```
public interface SupportLevelDescriptor
```
This class is used to describe custom settings for an operation; either changes to input values or additional output objects, or both. Some custom settings may appl to more than one country

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DATA_ADDRESS_POINT` Address point locations are contained in dictionaries
`static int`	`DATA_GEOGRAPHIC_AREA1_CENTROID` Future: make public when we can tell if area name 1 centroids are in data
`static int`	`DATA_GEOGRAPHIC_AREA2_CENTROID` Future: make public when we can tell if area name 2 centroids are in data
`static int`	`DATA_GEOGRAPHIC_AREA3_CENTROID` Future: make public when we can tell if area name 3 centroids are in data
`static int`	`DATA_GEOGRAPHIC_AREA4_CENTROID` Future: make public when we can tell if area name 4 centroids are in data
`static int`	`DATA_GEOGRAPHIC_CENTROID` Any level of geographic centroid information is contained in dictionaries
`static int`	`DATA_POSTAL_CENTROID` Main postal code centroid information is contained in dictionaries
`static int`	`DATA_POSTAL_EXTENSION_CENTROID` Future: make public when we can tell if postal code 2 centroids are in data
`static int`	`DATA_STREET_SEGMENT` Street segment information is contained in dictionaries

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getBaseObject()` Name of the object or operation that this describes a modification for
`List<String>`	`getCountries()` The countries for which this support level is valid.
`int`	`getSupportedDataLevel()` Not yet implemented.
`List<InputParam>`	`getUpdatedOptionalInput()` Changes to optional input of the base operation, if any
`List<OutputParam>`	`getUpdatedOptionalOutput()` Changes to output of the base operation, if any
`List<InputParam>`	`getUpdatedRequiredInput()` Changes to required input of the base operation, if any
`void`	`setBaseObject(String baseObject)` Name of the base object these modifications apply to
`void`	`setCountries(List<String> countries)` Countries this support level applies for
`void`	`setSupportedDataLevel(int level)` Not yet implemented.
`void`	`setUpdatedOptionalInput(List<InputParam> optionalInput)` Changes to optional input of the base operation, if any
`void`	`setUpdatedOptionalOutput(List<OutputParam> optionalOutput)` Changes to possible output of the base operation, if any
`void`	`setUpdatedRequiredInput(List<InputParam> requiredInput)` Changes to required input of the base operation, if any

- Field Detail
  - DATA_POSTAL_CENTROID
```
static final int DATA_POSTAL_CENTROID
```
    Main postal code centroid information is contained in dictionaries
    
    See Also:
    
    Constant Field Values
  - DATA_GEOGRAPHIC_CENTROID
```
static final int DATA_GEOGRAPHIC_CENTROID
```
    Any level of geographic centroid information is contained in dictionaries
    
    See Also:
    
    Constant Field Values
  - DATA_STREET_SEGMENT
```
static final int DATA_STREET_SEGMENT
```
    Street segment information is contained in dictionaries
    
    See Also:
    
    Constant Field Values
  - DATA_ADDRESS_POINT
```
static final int DATA_ADDRESS_POINT
```
    Address point locations are contained in dictionaries
    
    See Also:
    
    Constant Field Values
  - DATA_POSTAL_EXTENSION_CENTROID
```
static final int DATA_POSTAL_EXTENSION_CENTROID
```
    Future: make public when we can tell if postal code 2 centroids are in data
    
    See Also:
    
    Constant Field Values
  - DATA_GEOGRAPHIC_AREA1_CENTROID
```
static final int DATA_GEOGRAPHIC_AREA1_CENTROID
```
    Future: make public when we can tell if area name 1 centroids are in data
    
    See Also:
    
    Constant Field Values
  - DATA_GEOGRAPHIC_AREA2_CENTROID
```
static final int DATA_GEOGRAPHIC_AREA2_CENTROID
```
    Future: make public when we can tell if area name 2 centroids are in data
    
    See Also:
    
    Constant Field Values
  - DATA_GEOGRAPHIC_AREA3_CENTROID
```
static final int DATA_GEOGRAPHIC_AREA3_CENTROID
```
    Future: make public when we can tell if area name 3 centroids are in data
    
    See Also:
    
    Constant Field Values
  - DATA_GEOGRAPHIC_AREA4_CENTROID
```
static final int DATA_GEOGRAPHIC_AREA4_CENTROID
```
    Future: make public when we can tell if area name 4 centroids are in data
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getBaseObject
```
String getBaseObject()
```
    Name of the object or operation that this describes a modification for
    
    Returns:
    
    name of the base object
  - setBaseObject
```
void setBaseObject(String baseObject)
```
    Name of the base object these modifications apply to
    
    Parameters:
    
    baseObject - name of the base object or operation
  - getSupportedDataLevel
```
int getSupportedDataLevel()
```
    Not yet implemented. Eventually will return the levels of data (point, street segment, postal centroid, etc) availablel
    
    Returns:
    
    get data support level
  - setSupportedDataLevel
```
void setSupportedDataLevel(int level)
```
    Not yet implemented. Eventually will return the levels of data (point, street segment, postal centroid, etc) availablel
    
    Parameters:
    
    level - indicates data level
  - getCountries
```
List<String> getCountries()
```
    The countries for which this support level is valid. All countries are described by teir ISO-3166 3-char abbreviation
    
    Returns:
    
    list of countries
  - setCountries
```
void setCountries(List<String> countries)
```
    Countries this support level applies for
    
    Parameters:
    
    countries - which countries support level applies for
  - getUpdatedRequiredInput
```
List<InputParam> getUpdatedRequiredInput()
```
    Changes to required input of the base operation, if any
    
    Returns:
    
    list of modified or additional input parameters
  - setUpdatedRequiredInput
```
void setUpdatedRequiredInput(List<InputParam> requiredInput)
```
    Changes to required input of the base operation, if any
    
    Parameters:
    
    requiredInput - list of modified or additional input parameters
  - getUpdatedOptionalInput
```
List<InputParam> getUpdatedOptionalInput()
```
    Changes to optional input of the base operation, if any
    
    Returns:
    
    list of modified or additional input parameters
  - setUpdatedOptionalInput
```
void setUpdatedOptionalInput(List<InputParam> optionalInput)
```
    Changes to optional input of the base operation, if any
    
    Parameters:
    
    optionalInput - list of modified or additional input parameters
  - getUpdatedOptionalOutput
```
List<OutputParam> getUpdatedOptionalOutput()
```
    Changes to output of the base operation, if any
    
    Returns:
    
    list of modified or additional output objects
  - setUpdatedOptionalOutput
```
void setUpdatedOptionalOutput(List<OutputParam> optionalOutput)
```
    Changes to possible output of the base operation, if any
    
    Parameters:
    
    optionalOutput - list of modified or additional output parameters

Interface SupportLevelDescriptor

Field Summary

Method Summary

Field Detail

DATA_POSTAL_CENTROID

DATA_GEOGRAPHIC_CENTROID

DATA_STREET_SEGMENT

DATA_ADDRESS_POINT

DATA_POSTAL_EXTENSION_CENTROID

DATA_GEOGRAPHIC_AREA1_CENTROID

DATA_GEOGRAPHIC_AREA2_CENTROID

DATA_GEOGRAPHIC_AREA3_CENTROID

DATA_GEOGRAPHIC_AREA4_CENTROID

Method Detail

getBaseObject

setBaseObject

getSupportedDataLevel

setSupportedDataLevel

getCountries

setCountries

getUpdatedRequiredInput

setUpdatedRequiredInput

getUpdatedOptionalInput

setUpdatedOptionalInput

getUpdatedOptionalOutput

setUpdatedOptionalOutput