de.alpharogroup.address.book.rest.api

Interface FederalstatesResource

All Superinterfaces:

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

All Known Implementing Classes:

FederalstatesRestResource

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

Method Summary

Modifier and Type	Method and Description
de.alpharogroup.address.book.domain.Federalstate	findFederalstate(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.address.book.domain.Country,String> countryWithName) Find the first federal state from country.
de.alpharogroup.address.book.domain.Federalstate	findFederalstateFromIso3166A2code(String iso3166A2code) Find federal state from iso3166 a2code.
String	findFederalstateNameFromIso3166A2code(String iso3166A2code) Find federalstate name from iso3166 a2code.
List<de.alpharogroup.address.book.domain.Federalstate>	findFederalstatesFromCountry(de.alpharogroup.address.book.domain.Country country) Find federalstates from country.
List<de.alpharogroup.address.book.domain.Federalstate>	findFederalstatesFromCountry(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.address.book.domain.Country,String> countryWithName) Find federal states from country.
de.alpharogroup.address.book.domain.Federalstate	getFederalstate(String country, String stateCode) Gets the Federalstate from the given String objects.

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

create, delete, read, update

Method Detail

findFederalstate

@POST
 @Path(value="/find/federalstate/country/with/name")
de.alpharogroup.address.book.domain.Federalstate findFederalstate(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.address.book.domain.Country,String> countryWithName)

Find the first federal state from country.

Parameters:

countryWithName - the KeyValuePair object that encapsulate the country with the name of the federal state

Returns:

the the first federal state or null if not found.

findFederalstateFromIso3166A2code

@GET
 @Path(value="/find/federalstate/{iso3166A2code}/")
de.alpharogroup.address.book.domain.Federalstate findFederalstateFromIso3166A2code(@PathParam(value="iso3166A2code")
                                                                                                                                            String iso3166A2code)

Find federal state from iso3166 a2code.

Parameters:

iso3166A2code - the iso3166 a2code

Returns:

the federal states

findFederalstateNameFromIso3166A2code

@GET
 @Path(value="/find/federalstatestring/{iso3166A2code}/")
String findFederalstateNameFromIso3166A2code(@PathParam(value="iso3166A2code")
                                                                                                            String iso3166A2code)

Find federalstate name from iso3166 a2code.

Parameters:

iso3166A2code - the iso3166 a2code

Returns:

the string

findFederalstatesFromCountry

@POST
 @Path(value="/find/federalstates/country")
List<de.alpharogroup.address.book.domain.Federalstate> findFederalstatesFromCountry(de.alpharogroup.address.book.domain.Country country)

Find federalstates from country.

Parameters:

country - the country

Returns:

the list

findFederalstatesFromCountry

@POST
 @Path(value="/find/federalstates/country/with/name")
List<de.alpharogroup.address.book.domain.Federalstate> findFederalstatesFromCountry(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.address.book.domain.Country,String> countryWithName)

Find federal states from country.

Parameters:

countryWithName - the KeyValuePair object that encapsulate the country with the name of the federal state

Returns:

the list of found federal states.

getFederalstate

@GET
 @Path(value="/get/federalstate/{country}/{statecode}/")
de.alpharogroup.address.book.domain.Federalstate getFederalstate(@PathParam(value="country")
                                                                                                                               String country,
                                                                                                                               @PathParam(value="statecode")
                                                                                                                               String stateCode)

Gets the Federalstate from the given String objects. Example: "country=gr.grc, stateCode=gr.a" or "country=de.deu, stateCode=de.bw"

Parameters:

country - the country.

stateCode - the optional state string code.

Returns:

the federalstate