Package overit.geocallapp.wfm.inventory.rs2.warehouse.transfer.request.item

Class TransferRequestItemService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.inventory.rs2.warehouse.transfer.request.item.TransferRequestItemService

@RestController
@RequestMapping("inventory/r2/warehouses/transfers/requests/headers/{id:[0-9]+}/items")
@Resource(logging=true)
public class TransferRequestItemService
extends PrivateService

Services to manage transfer request items.

Since:

19.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
TransferRequestItemService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOTransferRequestItem>	get(Long id, Long itemId)	Retrieves the required DTOTransferRequestItem by calling from the TransferRequestItemLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOTransferRequestItem>>	getCollection(Long id, @NotNull @Valid Page page, @Valid @NotNull DTOTransferRequestItemFilter filter)	Returns the collection of all the stored transfer request items by calling the TransferRequestItemSearchEvent.
org.springframework.http.ResponseEntity<PageResponse<BOTransferRequestItemSerializedMaterial>>	getSerializedMaterials(Long id, Long itemId)	Retrieves the required stock serialized materials starting from the item id.
org.springframework.http.ResponseEntity<Void>	patch(Long id, Long itemId, @Valid DTOTransferRequestItemUpdate dto)	Updates the required transfer request item by calling from the TransferRequestItemUpdateEvent.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(Long id, @Valid DTOTransferRequestItemInsert dto)	Creates a new transfer request item by calling from the TransferRequestItemInsertEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

TransferRequestItemService

public TransferRequestItemService()

Method Details

getCollection

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

Returns the collection of all the stored transfer request items by calling the TransferRequestItemSearchEvent.

Parameters:

id - the transfer request header id

page - the Page that will contain the paginated result

filter - the DTOTransferRequestItemFilter

Returns:

the ResponseEntity containing the collection of DTOTransferRequestItem

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOTransferRequestItem by calling from the TransferRequestItemLoadEvent.

Parameters:

id - the transfer request header id

itemId - the item id

Returns:

the ResponseEntity containing the loaded DTOTransferRequestItem

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(@PathVariable("id")
 Long id,
 @Valid @RequestBody
 @Valid DTOTransferRequestItemInsert dto)
                                                                  throws DAValidateException,
DAException

Creates a new transfer request item by calling from the TransferRequestItemInsertEvent.

Parameters:

id - the transfer request header id

dto - the DTOTransferRequestItemInsert containing the insert data

Returns:

the ResponseEntity containing the id of the just inserted

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Updates the required transfer request item by calling from the TransferRequestItemUpdateEvent.

Parameters:

id - the transfer request header id

itemId - the item id

dto - the DTOTransferRequestItemUpdate containing the update data

Returns:

the ResponseEntity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getSerializedMaterials

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

Retrieves the required stock serialized materials starting from the item id. TransferRequestItemSerializedMaterialSearchEvent

Parameters:

id - the transfer request id

itemId - the transfer request item id

Returns:

the ResponseEntity containing the serialized materials of the stock

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception