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

Class StockService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.inventory.rs2.warehouse.stock.StockService

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

Services to manage the stocks.

Since:

19.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
StockService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOStock>	get(Long id)	Retrieves the required DTOStock by calling from the StockLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOStock>>	getCollection(@NotNull @Valid Page page, @Valid @NotNull DTOStockSearchFilter filter)	Retrieves all the stored stocks by calling the StockSearchEvent.
org.springframework.http.ResponseEntity<DTOStockHistory>	getHistory(Long stockId, Long id)	Retrieves the required stock history by calling the StockHistoryLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOMaterialStock>>	getMaterialStocks(@NotNull @Valid Page page, @Valid @NotNull DTOMaterialStockSearchFilter filter)	Retrieves the required stock grouping as required by calling the WarehouseMaterialStockSearchEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOStockSerializedMaterial>>	getSerializedMaterials(Long id)	Retrieves the required stock serialized materials by calling the StockSerializedMaterialSearchEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOStockHistory>>	getStockHistories(Long stockId, @NotNull @Valid Page page, @Valid @NotNull DTOStockHistorySearchFilter filter)	Retrieves all the stored stock history by calling the StockHistorySearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

StockService

public StockService()

Method Details

getCollection

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

Retrieves all the stored stocks by calling the StockSearchEvent.

Parameters:

page - the Page that will contain the paginated result

filter - the DTOStockSearchFilter

Returns:

the ResponseEntity containing the collection of DTOStock

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOStock by calling from the StockLoadEvent.

Parameters:

id - the stock id

Returns:

the ResponseEntity containing the loaded DTOStock

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getStockHistories

@GetMapping(value="{stockId:[0-9]+}/histories",
            produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOStockHistory>> getStockHistories(@PathVariable("stockId")
 Long stockId,
 @RequestParam("page") @NotNull @Valid
 @NotNull @Valid Page page,
 @RequestParam("filter") @Valid @NotNull
 @Valid @NotNull DTOStockHistorySearchFilter filter)
                                                                                         throws DAValidateException,
DAException

Retrieves all the stored stock history by calling the StockHistorySearchEvent.

Parameters:

stockId - the stock id

page - the Page that will contain the paginated result

filter - the DTOStockHistorySearchFilter

Returns:

the ResponseEntity containing the collection of DTOStockHistory

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getHistory

@GetMapping(value="{stockId:[0-9]+}/histories/{id:[0-9]+}",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTOStockHistory> getHistory(@PathVariable("stockId")
 Long stockId,
 @PathVariable("id")
 Long id)
                                                                    throws DAValidateException,
DAException

Retrieves the required stock history by calling the StockHistoryLoadEvent.

Parameters:

stockId - the stock id

id - ResponseEntity containing the loaded DTOStockHistory

Returns:

the ResponseEntity containing the loaded DTOStockHistory

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getSerializedMaterials

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

Retrieves the required stock serialized materials by calling the StockSerializedMaterialSearchEvent.

Parameters:

id - the stock id

Returns:

the ResponseEntity containing the serialized materials of the stock

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getMaterialStocks

@GetMapping(value="/actions/getMaterialStocks",
            produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOMaterialStock>> getMaterialStocks(@RequestParam("page") @NotNull @Valid
 @NotNull @Valid Page page,
 @RequestParam("filter") @Valid @NotNull
 @Valid @NotNull DTOMaterialStockSearchFilter filter)
                                                                                          throws DAValidateException,
DAException

Retrieves the required stock grouping as required by calling the WarehouseMaterialStockSearchEvent.

Parameters:

page - the Page that will contain the paginated result

filter - the DTOMaterialStockSearchFilter

Returns:

the ResponseEntity containing the required grouped stocks

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception