Package overit.geocallapp.wfm.locations.rs1.address

Class AddressService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.locations.rs1.address.AddressService

@RestController
@RequestMapping("territory/locations/r1/addresses")
@Resource(logging=true)
public class AddressService
extends PrivateService

Services to manage addresses.

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
AddressService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	batchPatch(@Size(min=1,max=200) @Valid List<DTOAddressBatchUpdate> batchInput)	Update a batch of addresses by calling the AddressUpdateBatchEvent
org.springframework.http.ResponseEntity<List<DTOIdentifier<Long>>>	batchPost(@Size(min=1,max=200) @Valid List<DTOAddressInsert> batchInput)	Create a batch of addresses by calling the AddressInsertBatchEvent
org.springframework.http.ResponseEntity<Void>	geocode(Long id)	Geocodes the given address by calling the AddressGeocodeEvent
org.springframework.http.ResponseEntity<Void>	geocodingBatchSave(@Size(min=1,max=10) Collection<Long> ids)	Geocodes the given set of addresses by calling the AddressGeocodingBatchSaveEvent
org.springframework.http.ResponseEntity<DTOAddress>	get(Long id, Collection<String> fields)	Retrieves the required address.
org.springframework.http.ResponseEntity<PageResponse<DTOAddress>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOAddressSearchFilter filter)	Retrieve the all stored addresses.
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOAddressUpdate input)	Modifies the required address.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOAddressInsert input)	Create a new address.

Methods inherited from class java.lang.Object

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

Constructor Details

AddressService

public AddressService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOAddress>> getCollection(@RequestParam("_page") @Valid
 @Valid Page page,
 @RequestParam(required=false,name="_fields")
 Collection<String> fields,
 @RequestParam(required=false,name="_order")
 String order,
 @Valid
 @Valid DTOAddressSearchFilter filter)
                                                                                throws DAValidateException,
DAException

Retrieve the all stored addresses. AddressSearchEvent

Parameters:

page - the required result page

fields - the collection of fields the response will contain

order - the ordering field

filter - the specified DTOAddressSearchFilter

Returns:

the response containing the current result page

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

@GetMapping(value="{addressId:[0-9]+}",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTOAddress> get(@PathVariable("addressId")
 Long id,
 @RequestParam(required=false,name="_fields")
 Collection<String> fields)
                                                        throws DAValidateException,
DAException

Retrieves the required address. AddressLoadEvent

Parameters:

id - address id

fields - the collection of fields the response will contain

Returns:

the response containing the required address

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

post

@PostMapping(consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<DTOIdentifier<Long>> post(@Valid @RequestBody
 @Valid DTOAddressInsert input)
                                                                  throws DAValidateException,
DAException

Create a new address. AddressInsertEvent

Parameters:

input - the DTOAddressInsert

Returns:

the standard response containing the new address id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

geocode

@PostMapping(value="{addressId:[0-9]+}/geocoding",
             produces="application/json")
public org.springframework.http.ResponseEntity<Void> geocode(@PathVariable("addressId")
 Long id)
                                                      throws DAValidateException,
DAException

Geocodes the given address by calling the AddressGeocodeEvent

Parameters:

id - the address id

Returns:

a standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

@PatchMapping(value="{addressId:[0-9]+}",
              consumes="application/json",
              produces="application/json")
public org.springframework.http.ResponseEntity<Void> patch(@PathVariable("addressId")
 Long id,
 @Valid @RequestBody
 @Valid DTOAddressUpdate input)
                                                    throws DAValidateException,
DAException

Modifies the required address. AddressUpdateEvent

Parameters:

id - the address id

input - the address update DTOAddressUpdate

Returns:

a standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

batchPost

@PostMapping(value="/batch",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<List<DTOIdentifier<Long>>> batchPost(@Size(min=1,max=200) @Valid @RequestBody
 @Size(min=1,max=200) @Valid List<DTOAddressInsert> batchInput)
                                                                             throws DAValidateException,
DAException

Create a batch of addresses by calling the AddressInsertBatchEvent

Parameters:

batchInput - a list of DTOAddressInsert

Returns:

the standard response containing the list of new address ids

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

batchPatch

@PatchMapping(value="/batch",
              consumes="application/json",
              produces="application/json")
public org.springframework.http.ResponseEntity<Void> batchPatch(@Size(min=1,max=200) @Valid @RequestBody
 @Size(min=1,max=200) @Valid List<DTOAddressBatchUpdate> batchInput)
                                                         throws DAValidateException,
DAException

Update a batch of addresses by calling the AddressUpdateBatchEvent

Parameters:

batchInput - a list of DTOAddressBatchUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

geocodingBatchSave

@PostMapping(value="/geocoding/batch",
             produces="application/json")
public org.springframework.http.ResponseEntity<Void> geocodingBatchSave(@Size(min=1,max=10) @RequestParam(name="ids")
 @Size(min=1,max=10) Collection<Long> ids)
                                                                 throws DAValidateException,
DAException

Geocodes the given set of addresses by calling the AddressGeocodingBatchSaveEvent

Parameters:

ids - the set of address ids

Returns:

a standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception