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

Class TransferRequestHeaderService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.inventory.rs2.warehouse.transfer.request.header.TransferRequestHeaderService

@RestController
@RequestMapping("inventory/r2/warehouses/transfers/requests/headers")
@Resource(logging=true)
public class TransferRequestHeaderService
extends PrivateService

Services to manage transfer request headers.

Since:

19.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
TransferRequestHeaderService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOTransferRequestHeader>	get(Long id)	Retrieves the required DTOTransferRequestHeader by calling from the TransferRequestHeaderLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOTransferRequestHeader>>	getCollection(@NotNull @Valid Page page, @Valid @NotNull DTOTransferRequestHeaderFilter filter, String ordering)	Returns the collection of all the stored transfer request headers by calling the TransferRequestHeaderSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOTransferRequestHeaderUpdate dto)	Updates the required transfer request header by calling from the TransferRequestHeaderUpdateEvent.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOTransferRequestHeaderInsert dto)	Creates a new transfer request header by calling from the TransferRequestHeaderInsertEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

TransferRequestHeaderService

public TransferRequestHeaderService()

Method Details

getCollection

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

Returns the collection of all the stored transfer request headers by calling the TransferRequestHeaderSearchEvent.

Parameters:

page - the Page that will contain the paginated result

filter - the DTOTransferRequestHeaderFilter

ordering - the attributes that will be used as ordering

Returns:

the ResponseEntity containing the collection of DTOTransferRequestHeader

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOTransferRequestHeader by calling from the TransferRequestHeaderLoadEvent.

Parameters:

id - the id of the transfer request header to load

Returns:

the ResponseEntity containing the loaded DTOTransferRequestHeader

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

Creates a new transfer request header by calling from the TransferRequestHeaderInsertEvent.

Parameters:

dto - the DTOTransferRequestHeaderInsert containing the insert data

Returns:

the ResponseEntity containing the id of the inserted transfer request header

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

Updates the required transfer request header by calling from the TransferRequestHeaderUpdateEvent.

Parameters:

id - the id of the transfer request header to update

dto - the DTOTransferRequestHeaderUpdate containing the update data

Returns:

the ResponseEntity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception