Package info.ejava.assignments.api.houserenters.svc.houses

Class HousesController

java.lang.Object

info.ejava.assignments.api.houserenters.svc.houses.HousesController

@RestController
public class HousesController
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private final HousesService	housesService

Constructor Summary

Constructors

Constructor	Description
HousesController()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<HouseDTO>	createHouse(HouseDTO house)
org.springframework.http.ResponseEntity<HouseListDTO>	findHousesList(String id, String name, Integer people, Integer bedrooms, BigDecimal dailyRate, Integer minPeople, Integer maxPeople, Integer minBedrooms, Integer maxBedrooms, Integer minDailyRate, Integer maxDailyRate, Integer pageNumber, Integer pageSize)	This query endpoint uses non-exact search criteria to form range queries.
org.springframework.http.ResponseEntity<HouseDTO>	getHouse(String id)
org.springframework.http.ResponseEntity<Void>	hasHouse(String id)
(package private) void	init()
org.springframework.http.ResponseEntity<Void>	removeAllHouses()
org.springframework.http.ResponseEntity<Void>	removeHouse(String id)
org.springframework.http.ResponseEntity<HouseDTO>	updateHouse(String id, HouseDTO houseUpdate)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

housesService

private final HousesService housesService

Constructor Details

HousesController

public HousesController()

Method Details

init

@PostConstruct
void init()

createHouse

@RequestMapping(path="/api/houses",
                method=POST,
                consumes="application/json",
                produces="application/json")
public org.springframework.http.ResponseEntity<HouseDTO> createHouse(@RequestBody
 HouseDTO house)

findHousesList

@RequestMapping(path="/api/houses",
                method=GET,
                produces="application/json")
public org.springframework.http.ResponseEntity<HouseListDTO> findHousesList(@RequestParam(value="id",required=false)
 String id,
 @RequestParam(value="name",required=false)
 String name,
 @RequestParam(value="people",required=false)
 Integer people,
 @RequestParam(value="bedrooms",required=false)
 Integer bedrooms,
 @RequestParam(value="dailyRate",required=false)
 BigDecimal dailyRate,
 @RequestParam(value="minPeople",required=false)
 Integer minPeople,
 @RequestParam(value="maxPeople",required=false)
 Integer maxPeople,
 @RequestParam(value="minBedrooms",required=false)
 Integer minBedrooms,
 @RequestParam(value="maxBedrooms",required=false)
 Integer maxBedrooms,
 @RequestParam(value="minDailyRate",required=false)
 Integer minDailyRate,
 @RequestParam(value="maxDailyRate",required=false)
 Integer maxDailyRate,
 @RequestParam(value="pageNumber",required=false)
 Integer pageNumber,
 @RequestParam(value="pageSize",required=false)
 Integer pageSize)

This query endpoint uses non-exact search criteria to form range queries. Most of the values are inclusive. One is exclusive to just provide an example of its potential impact. Not all properties are represented.

Parameters:

minPeople - inclusive

maxPeople - inclusive

minDailyRate - inclusive

maxDailyRate - exclusive

pageNumber - window of houses based on the pageSize; all if not supplied

pageSize - number of houses to include in response; all if not supplied

Returns:

list of contents containing houses

getHouse

@RequestMapping(path="/api/houses/{id}",
                method=GET,
                produces="application/json")
public org.springframework.http.ResponseEntity<HouseDTO> getHouse(@PathVariable("id")
 String id)

hasHouse

@RequestMapping(path="/api/houses/{id}",
                method=HEAD,
                produces="application/json")
public org.springframework.http.ResponseEntity<Void> hasHouse(@PathVariable("id")
 String id)

updateHouse

@RequestMapping(path="/api/houses/{id}",
                method=PUT,
                consumes="application/json")
public org.springframework.http.ResponseEntity<HouseDTO> updateHouse(@PathVariable("id")
 String id,
 @RequestBody
 HouseDTO houseUpdate)

removeHouse

@RequestMapping(path="/api/houses/{id}",
                method=DELETE)
public org.springframework.http.ResponseEntity<Void> removeHouse(@PathVariable("id")
 String id)

removeAllHouses

@RequestMapping(path="/api/houses",
                method=DELETE)
public org.springframework.http.ResponseEntity<Void> removeAllHouses()