Package overit.geocallapp.wfm.inventory.rs2.warehouse.central

Class CentralWarehouseService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.inventory.rs2.warehouse.central.CentralWarehouseService

@RestController
@RequestMapping("inventory/r2/warehouses/centrals")
@Resource(logging=true)
public class CentralWarehouseService
extends PrivateService

Services to manage central warehouses.

Since:

19.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
CentralWarehouseService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	activate(Long id)	Activates the required central warehouse by calling the CentralWarehouseActivateEvent.
org.springframework.http.ResponseEntity<DTOCentralWarehouse>	get(Long id, String language)	Retrieves the required central warehouse by calling the CentralWarehouseLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOCentralWarehouse>>	getCollection(@NotNull @Valid Page page, @Valid @NotNull DTOCentralWarehouseSearchFilter filter)	Returns the collection of all the stored central warehouses by calling the CentralWarehouseSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOCentralWarehouseUpdate dto)	Updates the required central warehouse by calling the CentralWarehouseUpdateEvent.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOCentralWarehouseInsert dto)	Create a new central warehouse by calling the CentralWarehouseInsertEvent

Methods inherited from class java.lang.Object

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

Constructor Details

CentralWarehouseService

public CentralWarehouseService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOCentralWarehouse>> getCollection(@RequestParam("page") @NotNull @Valid
 @NotNull @Valid Page page,
 @RequestParam("filter") @Valid @NotNull
 @Valid @NotNull DTOCentralWarehouseSearchFilter filter)
                                                                                         throws DAValidateException,
DAException

Returns the collection of all the stored central warehouses by calling the CentralWarehouseSearchEvent.

Parameters:

page - the Page that will contain the paginated result

filter - the DTOCentralWarehouseSearchFilter

Returns:

the ResponseEntity containing the collection of DTOCentralWarehouse

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required central warehouse by calling the CentralWarehouseLoadEvent.

Parameters:

id - central warehouse id

language - the language of the user

Returns:

the ResponseEntity containing the loaded DTOCentralWarehouse

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 DTOCentralWarehouseInsert dto)
                                                                  throws DAValidateException,
DAException

Create a new central warehouse by calling the CentralWarehouseInsertEvent

Parameters:

dto - the DTOCentralWarehouseInsert

Returns:

the ResponseEntity containing the created central warehouse id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Updates the required central warehouse by calling the CentralWarehouseUpdateEvent.

Parameters:

id - the central warehouse id

dto - the DTOCentralWarehouseUpdate

Returns:

the ResponseEntity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

activate

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

Activates the required central warehouse by calling the CentralWarehouseActivateEvent.

Parameters:

id - the central warehouse id

Returns:

the ResponseEntity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception