de.alpharogroup.address.book.rest.api

Interface ZipcodesResource

All Superinterfaces:

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

All Known Implementing Classes:

ZipcodesRestResource

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

Method Summary

Modifier and Type	Method and Description
Response	existsZipcode(String zipcode) Checks if the given zipcode string exists.
List<de.alpharogroup.address.book.domain.Zipcode>	find(de.alpharogroup.address.book.domain.Country country) Finds all Zipcode from the given Country object.
List<de.alpharogroup.address.book.domain.Zipcode>	findAll(de.alpharogroup.collections.pairs.Triple<de.alpharogroup.address.book.domain.Country,String,String> searchCriteria) Gets a List of Zipcode with the given parameters that can be null if they shell be ignored in the query.
de.alpharogroup.address.book.domain.Zipcode	findCityFromZipcode(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.address.book.domain.Country,String> countryWithZipcode) Find the Zipcode to resolve the city from the given Country object and zipcode string encapsulated as a KeyValuePair object as parameter.
List<de.alpharogroup.address.book.domain.Zipcode>	findZipcodes(String zipcode) Find Zipcode objects from the given zipcode string.
de.alpharogroup.address.book.domain.Zipcode	getZipcode(String zipcode, String city) Gets the Zipcode object from the given zipcode string and city.

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

create, delete, read, update

Method Detail

existsZipcode

@GET
 @Path(value="/exists/{zipcode}/")
Response existsZipcode(@PathParam(value="zipcode")
                                                               String zipcode)

Checks if the given zipcode string exists.

Parameters:

zipcode - the zipcode

Returns:

true, if successful

find

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

Finds all Zipcode from the given Country object.

Parameters:

country - the country

Returns:

the list of Zipcode

findAll

@POST
 @Path(value="/find/all")
List<de.alpharogroup.address.book.domain.Zipcode> findAll(de.alpharogroup.collections.pairs.Triple<de.alpharogroup.address.book.domain.Country,String,String> searchCriteria)

Gets a List of Zipcode with the given parameters that can be null if they shell be ignored in the query.

Parameters:

searchCriteria - the search criteria

Returns:

the list of Zipcode objects

findCityFromZipcode

@POST
 @Path(value="/find/city/from/zipcode")
de.alpharogroup.address.book.domain.Zipcode findCityFromZipcode(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.address.book.domain.Country,String> countryWithZipcode)

Find the Zipcode to resolve the city from the given Country object and zipcode string encapsulated as a KeyValuePair object as parameter.

Parameters:

countryWithZipcode - the KeyValuePair object that encapsulate the country with the zipcode

Returns:

the Zipcode object

findZipcodes

@GET
 @Path(value="/find/{zipcode}/")
List<de.alpharogroup.address.book.domain.Zipcode> findZipcodes(@PathParam(value="zipcode")
                                                                                                     String zipcode)

Find Zipcode objects from the given zipcode string.

Parameters:

zipcode - the zipcode

Returns:

the list of Zipcode

getZipcode

@GET
 @Path(value="/get/{zipcode}/{city}")
de.alpharogroup.address.book.domain.Zipcode getZipcode(@PathParam(value="zipcode")
                                                                                                  String zipcode,
                                                                                                  @PathParam(value="city")
                                                                                                  String city)

Gets the Zipcode object from the given zipcode string and city. If it does not exist it will be create a new Zipcode object.

Parameters:

zipcode - the zipcode

city - the city

Returns:

the Zipcode