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

Interface HousesAPI

All Known Implementing Classes:
HousesAPIClient
public interface HousesAPI
This interface defines the REST-like, RMM-level3 interface to the House Service.

  • Field Details

  • Method Details

    • withRestTemplate

      HousesAPIClient withRestTemplate(org.springframework.web.client.RestTemplate restTemplate)
      Used to change the authenticated identity of the client when security has been enabled.
      Parameters:
      restTemplate - contains basis for client/identity
      Returns:
      new client using the supplied restTemplate

    • createHouse

      org.springframework.http.ResponseEntity<HouseDTO> createHouse(HouseDTO house)

    • findHousesBy

      org.springframework.http.ResponseEntity<HouseListDTO> findHousesBy(HouseSearchParams searchParams, org.springframework.data.domain.Pageable pageable)
      An example query using a GET and query parameters. Useful in expressing range searches.
      Parameters:
      searchParams - object expressing min/max properties
      pageable - paging constraints
      Returns:
      list of results

    • getHouse

      org.springframework.http.ResponseEntity<HouseDTO> getHouse(String id)

    • hasHouse

      org.springframework.http.ResponseEntity<Void> hasHouse(String id)

    • updateHouse

      org.springframework.http.ResponseEntity<HouseDTO> updateHouse(String id, HouseDTO house)

    • removeHouse

      org.springframework.http.ResponseEntity<Void> removeHouse(String id)

    • removeAllHouses

      org.springframework.http.ResponseEntity<Void> removeAllHouses()