Response (geocodingservices - geocoding-api 5.1.854 API)

```
public interface Response
```
Contains the response from a geocode or reverse geocode call

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ERROR_KEY` If this key is present in the custom values of the Response object, then an error occured during the operation.
`static String`	`PARSED_INPUT_ADDRESS_NUMBER`
`static String`	`PARSED_INPUT_AREA_NAME_1`
`static String`	`PARSED_INPUT_AREA_NAME_2`
`static String`	`PARSED_INPUT_AREA_NAME_3`
`static String`	`PARSED_INPUT_AREA_NAME_4`
`static String`	`PARSED_INPUT_COUNTRY`
`static String`	`PARSED_INPUT_FORMATTED_INPUT_STREET`
`static String`	`PARSED_INPUT_GENERIC_FIELD_1`
`static String`	`PARSED_INPUT_GENERIC_FIELD_2`
`static String`	`PARSED_INPUT_GENERIC_FIELD_3`
`static String`	`PARSED_INPUT_GENERIC_FIELD_4`
`static String`	`PARSED_INPUT_INTERSECTING_STREET`
`static String`	`PARSED_INPUT_PLACE_NAME`
`static String`	`PARSED_INPUT_POST_CODE_1`
`static String`	`PARSED_INPUT_POST_CODE_2`
`static String`	`PARSED_INPUT_STREET_NAME`
`static String`	`PARSED_INPUT_STREET_POST_DIRECTIONAL`
`static String`	`PARSED_INPUT_STREET_POST_TYPE`
`static String`	`PARSED_INPUT_STREET_PRE_DIRECTIONAL`
`static String`	`PARSED_INPUT_STREET_PRE_TYPE`
`static String`	`PARSED_INPUT_UNIT_TYPE`
`static String`	`PARSED_INPUT_UNIT_VALUE`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`List<Candidate>`	`getCandidates()` Get the list of candidates.
`Set<String>`	`getCustomFieldKeys()` If the response has custom key-value pairs, returns the keys hat may be used to retrieve values
`String`	`getCustomFieldValue(String key)` Return an individual custom field value
`Map<String,String>`	`getCustomValues()` returns any custom values in the response.
`int`	`getTotalMatches()` Returns the number of candidates found that would be considered close candidates
`int`	`getTotalPossibleCandidates()` Returns the number of candidates found for this geocode

- Field Detail
  - PARSED_INPUT_PLACE_NAME
```
static final String PARSED_INPUT_PLACE_NAME
```
    See Also:
    
    Constant Field Values
  - PARSED_INPUT_ADDRESS_NUMBER
```
static final String PARSED_INPUT_ADDRESS_NUMBER
```
    See Also:
    
    Constant Field Values
  - PARSED_INPUT_STREET_NAME
```
static final String PARSED_INPUT_STREET_NAME
```
    See Also:
    
    Constant Field Values
  - PARSED_INPUT_STREET_PRE_DIRECTIONAL
```
static final String PARSED_INPUT_STREET_PRE_DIRECTIONAL
```
    See Also:
    
    Constant Field Values
  - PARSED_INPUT_STREET_POST_DIRECTIONAL
```
static final String PARSED_INPUT_STREET_POST_DIRECTIONAL
```
    See Also:
    
    Constant Field Values
  - PARSED_INPUT_STREET_PRE_TYPE
```
static final String PARSED_INPUT_STREET_PRE_TYPE
```
    See Also:
    
    Constant Field Values
  - PARSED_INPUT_STREET_POST_TYPE
```
static final String PARSED_INPUT_STREET_POST_TYPE
```
    See Also:
    
    Constant Field Values
  - PARSED_INPUT_UNIT_TYPE
```
static final String PARSED_INPUT_UNIT_TYPE
```
    See Also:
    
    Constant Field Values
  - PARSED_INPUT_UNIT_VALUE
```
static final String PARSED_INPUT_UNIT_VALUE
```
    See Also:
    
    Constant Field Values
  - PARSED_INPUT_AREA_NAME_1
```
static final String PARSED_INPUT_AREA_NAME_1
```
    See Also:
    
    Constant Field Values
  - PARSED_INPUT_AREA_NAME_2
```
static final String PARSED_INPUT_AREA_NAME_2
```
    See Also:
    
    Constant Field Values
  - PARSED_INPUT_AREA_NAME_3
```
static final String PARSED_INPUT_AREA_NAME_3
```
    See Also:
    
    Constant Field Values
  - PARSED_INPUT_AREA_NAME_4
```
static final String PARSED_INPUT_AREA_NAME_4
```
    See Also:
    
    Constant Field Values
  - PARSED_INPUT_POST_CODE_1
```
static final String PARSED_INPUT_POST_CODE_1
```
    See Also:
    
    Constant Field Values
  - PARSED_INPUT_POST_CODE_2
```
static final String PARSED_INPUT_POST_CODE_2
```
    See Also:
    
    Constant Field Values
  - PARSED_INPUT_GENERIC_FIELD_1
```
static final String PARSED_INPUT_GENERIC_FIELD_1
```
    See Also:
    
    Constant Field Values
  - PARSED_INPUT_GENERIC_FIELD_2
```
static final String PARSED_INPUT_GENERIC_FIELD_2
```
    See Also:
    
    Constant Field Values
  - PARSED_INPUT_GENERIC_FIELD_3
```
static final String PARSED_INPUT_GENERIC_FIELD_3
```
    See Also:
    
    Constant Field Values
  - PARSED_INPUT_GENERIC_FIELD_4
```
static final String PARSED_INPUT_GENERIC_FIELD_4
```
    See Also:
    
    Constant Field Values
  - PARSED_INPUT_INTERSECTING_STREET
```
static final String PARSED_INPUT_INTERSECTING_STREET
```
    See Also:
    
    Constant Field Values
  - PARSED_INPUT_COUNTRY
```
static final String PARSED_INPUT_COUNTRY
```
    See Also:
    
    Constant Field Values
  - PARSED_INPUT_FORMATTED_INPUT_STREET
```
static final String PARSED_INPUT_FORMATTED_INPUT_STREET
```
    See Also:
    
    Constant Field Values
  - ERROR_KEY
```
static final String ERROR_KEY
```
    If this key is present in the custom values of the Response object, then an error occured during the operation. The value associated with the key will describe the error
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getCandidates
```
List<Candidate> getCandidates()
```
    Get the list of candidates. List may be empty but should never be null
    
    Returns:
    
    list of candidates found
  - getTotalPossibleCandidates
```
int getTotalPossibleCandidates()
```
    Returns the number of candidates found for this geocode
    
    Returns:
    
    number candidates found
  - getTotalMatches
```
int getTotalMatches()
```
    Returns the number of candidates found that would be considered close candidates
    
    Returns:
    
    number of close candidates found
  - getCustomValues
```
Map<String,String> getCustomValues()
```
    returns any custom values in the response.
    
    Returns:
    
    map of custom fields from geocoder
  - getCustomFieldKeys
```
Set<String> getCustomFieldKeys()
```
    If the response has custom key-value pairs, returns the keys hat may be used to retrieve values
    
    Returns:
    
    set containing any custom keys
  - getCustomFieldValue
```
String getCustomFieldValue(String key)
```
    Return an individual custom field value
    
    Parameters:
    
    key - key of the custom field
    
    Returns:
    
    any value associated with the given key, or null if no value found

Interface Response

Field Summary

Method Summary

Field Detail

PARSED_INPUT_PLACE_NAME

PARSED_INPUT_ADDRESS_NUMBER

PARSED_INPUT_STREET_NAME

PARSED_INPUT_STREET_PRE_DIRECTIONAL

PARSED_INPUT_STREET_POST_DIRECTIONAL

PARSED_INPUT_STREET_PRE_TYPE

PARSED_INPUT_STREET_POST_TYPE

PARSED_INPUT_UNIT_TYPE

PARSED_INPUT_UNIT_VALUE

PARSED_INPUT_AREA_NAME_1

PARSED_INPUT_AREA_NAME_2

PARSED_INPUT_AREA_NAME_3

PARSED_INPUT_AREA_NAME_4

PARSED_INPUT_POST_CODE_1

PARSED_INPUT_POST_CODE_2

PARSED_INPUT_GENERIC_FIELD_1

PARSED_INPUT_GENERIC_FIELD_2

PARSED_INPUT_GENERIC_FIELD_3

PARSED_INPUT_GENERIC_FIELD_4

PARSED_INPUT_INTERSECTING_STREET

PARSED_INPUT_COUNTRY

PARSED_INPUT_FORMATTED_INPUT_STREET

ERROR_KEY

Method Detail

getCandidates

getTotalPossibleCandidates

getTotalMatches

getCustomValues

getCustomFieldKeys

getCustomFieldValue