de.alpharogroup.address.book.rest.api

Interface CountriesResource

All Superinterfaces:

de.alpharogroup.service.rs.RestfulResource<Integer,de.alpharogroup.address.book.domain.Country>

All Known Implementing Classes:

CountriesRestResource

@Path(value="/country/")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public interface CountriesResource
extends de.alpharogroup.service.rs.RestfulResource<Integer,de.alpharogroup.address.book.domain.Country>

Method Summary

Modifier and Type	Method and Description
de.alpharogroup.address.book.domain.Country	find(String iso3166A2name) Find the Country object from the given ISO 3166 String object.
List<de.alpharogroup.address.book.domain.Country>	findAll(String iso3166A2name, String iso3166A3name, String iso3166Number, String name) Find all Country from the given arguments.
de.alpharogroup.address.book.domain.Country	findByName(String name) Find the Country object by name.
List<de.alpharogroup.collections.pairs.KeyValuesPair<String,String>>	getCountriesToFederalstatesAsStringList() Gets a list with the mapping-class: the key is the name of the country and as value the corresponding federal states as a List of Iso3166A2code String objects.
List<de.alpharogroup.collections.pairs.KeyValuesPair<de.alpharogroup.address.book.domain.Country,de.alpharogroup.address.book.domain.Federalstate>>	getCountriesToFederalstatesList() Gets a list with the mapping-class: the key as Country object and as value the corresponding federal states as a List of Federalstate objects.
List<de.alpharogroup.collections.pairs.KeyValuesPair<String,String>>	getCountriesToZipcodesAndCitiesAsStringList() Gets a list with the mapping-class: the key is the name of the country and as value the corresponding zipcodes and cities as a List of String objects.
List<de.alpharogroup.collections.pairs.KeyValuesPair<String,String>>	getCountriesToZipcodesAsStringList() Gets a list with the mapping-class: the key is the name of the country and as value the corresponding zipcodes as a List of String objects.
List<de.alpharogroup.collections.pairs.KeyValuesPair<de.alpharogroup.address.book.domain.Country,de.alpharogroup.address.book.domain.Zipcode>>	getCountriesToZipcodesList() Gets a list with the mapping-class: the key as Country object and as value the corresponding Zipcodes as a List of Zipcode objects.
List<de.alpharogroup.collections.pairs.KeyValuesPair<String,String>>	getGermanCountriesToZipcodesAndCitiesAsStringList() Gets the german countries to zipcodes and cities as string list.
List<de.alpharogroup.collections.pairs.KeyValuesPair<String,String>>	getGermanCountriesToZipcodesAsStringList() Gets the german countries to zipcodes as string list.
List<de.alpharogroup.collections.pairs.KeyValuesPair<de.alpharogroup.address.book.domain.Country,de.alpharogroup.address.book.domain.Zipcode>>	getGermanCountriesToZipcodesList() Gets a list with the mapping-class: the key is the name of the country and as value the corresponding zipcodes as a List of String objects.
de.alpharogroup.address.book.domain.model.AddressSearchModel	setLocationSearchModel(de.alpharogroup.address.book.domain.model.AddressSearchModel modelObject) Sets the given AddressSearchModel object and returns it.

Methods inherited from interface de.alpharogroup.service.rs.RestfulResource

create, delete, read, update

Method Detail

find

@GET
 @Path(value="/find/by/isoa2/{iso3166A2name}")
de.alpharogroup.address.book.domain.Country find(String iso3166A2name)

Find the Country object from the given ISO 3166 String object.

Parameters:

iso3166A2name - the iso3166 a2name

Returns:

the Country object

findAll

@GET
 @Path(value="/find/{iso3166A2name}/{iso3166A3name}/{iso3166Number}/{name}")
List<de.alpharogroup.address.book.domain.Country> findAll(@PathParam(value="iso3166A2name")
                                                                                                                                            String iso3166A2name,
                                                                                                                                            @PathParam(value="iso3166A3name")
                                                                                                                                            String iso3166A3name,
                                                                                                                                            @PathParam(value="iso3166Number")
                                                                                                                                            String iso3166Number,
                                                                                                                                            @PathParam(value="name")
                                                                                                                                            String name)

Find all Country from the given arguments.

Parameters:

iso3166A2name - the iso3166 a2name

iso3166A3name - the iso3166 a3name

iso3166Number - the iso3166 number

name - the name

Returns:

the list of Country

findByName

@GET
 @Path(value="/find/by/name/{iso3166A2name}")
de.alpharogroup.address.book.domain.Country findByName(String name)

Find the Country object by name.

Parameters:

name - the name

Returns:

the countries

getCountriesToFederalstatesAsStringList

@GET
 @Path(value="/get/country2federalstate/stringlist/")
List<de.alpharogroup.collections.pairs.KeyValuesPair<String,String>> getCountriesToFederalstatesAsStringList()

Gets a list with the mapping-class: the key is the name of the country and as value the corresponding federal states as a List of Iso3166A2code String objects.

Returns:

the countries to federalstates as string list

getCountriesToFederalstatesList

@GET
 @Path(value="/get/country2federalstate/list/")
List<de.alpharogroup.collections.pairs.KeyValuesPair<de.alpharogroup.address.book.domain.Country,de.alpharogroup.address.book.domain.Federalstate>> getCountriesToFederalstatesList()

Gets a list with the mapping-class: the key as Country object and as value the corresponding federal states as a List of Federalstate objects.

Returns:

the countries to federalstates list

getCountriesToZipcodesAndCitiesAsStringList

@GET
 @Path(value="/get/country2zipcodesandcities/stringlist/")
List<de.alpharogroup.collections.pairs.KeyValuesPair<String,String>> getCountriesToZipcodesAndCitiesAsStringList()

Gets a list with the mapping-class: the key is the name of the country and as value the corresponding zipcodes and cities as a List of String objects.

Returns:

the countries to zipcodes and cities as string list

getCountriesToZipcodesAsStringList

@GET
 @Path(value="/get/country2zipcodes/stringlist/")
List<de.alpharogroup.collections.pairs.KeyValuesPair<String,String>> getCountriesToZipcodesAsStringList()

Gets a list with the mapping-class: the key is the name of the country and as value the corresponding zipcodes as a List of String objects.

Returns:

the countries to zipcodes as string list

getCountriesToZipcodesList

@GET
 @Path(value="/get/country2zipcodes/list/")
List<de.alpharogroup.collections.pairs.KeyValuesPair<de.alpharogroup.address.book.domain.Country,de.alpharogroup.address.book.domain.Zipcode>> getCountriesToZipcodesList()

Gets a list with the mapping-class: the key as Country object and as value the corresponding Zipcodes as a List of Zipcode objects.

Returns:

the countries to zipcodes list

getGermanCountriesToZipcodesAndCitiesAsStringList

@GET
 @Path(value="/get/germancountry2zipcodesandcities/stringlist/")
List<de.alpharogroup.collections.pairs.KeyValuesPair<String,String>> getGermanCountriesToZipcodesAndCitiesAsStringList()

Gets the german countries to zipcodes and cities as string list.

Returns:

the german countries to zipcodes and cities as string list

getGermanCountriesToZipcodesAsStringList

@GET
 @Path(value="/get/germancountry2zipcodes/stringlist/")
List<de.alpharogroup.collections.pairs.KeyValuesPair<String,String>> getGermanCountriesToZipcodesAsStringList()

Gets the german countries to zipcodes as string list.

Returns:

the german countries to zipcodes as string list

getGermanCountriesToZipcodesList

@GET
 @Path(value="/get/germancountry2zipcodes/list/")
List<de.alpharogroup.collections.pairs.KeyValuesPair<de.alpharogroup.address.book.domain.Country,de.alpharogroup.address.book.domain.Zipcode>> getGermanCountriesToZipcodesList()

Gets a list with the mapping-class: the key is the name of the country and as value the corresponding zipcodes as a List of String objects.

Returns:

the countries to zipcodes as string list for german speeking countries only

setLocationSearchModel

@POST
 @Path(value="/resolve/location")
de.alpharogroup.address.book.domain.model.AddressSearchModel setLocationSearchModel(de.alpharogroup.address.book.domain.model.AddressSearchModel modelObject)

Sets the given AddressSearchModel object and returns it.

Parameters:

modelObject - the model object

Returns:

the modified AddressSearchModel object.