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

Class WarehouseMaterialService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.inventory.rs2.warehouse.warehousematerial.WarehouseMaterialService

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

Services to manage warehouse materials.

Since:

19.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
WarehouseMaterialService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	activateWarehouseMaterial(Long id)	Activates the warehouse material by calling the WarehouseMaterialActivateEvent.
org.springframework.http.ResponseEntity<Void>	deactivateWarehouseMaterial(Long id)	Deactivates the warehouse material by calling the WarehouseMaterialDeactivateEvent.
org.springframework.http.ResponseEntity<DTOWarehouseMaterial>	get(Long id)	Retrieves the required warehouse material by calling the WarehouseMaterialLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOWarehouseMaterial>>	getCollection(@NotNull @Valid Page page, @Valid @NotNull DTOWarehouseMaterialSearchFilter filter)	Retrieves all the stored warehouse material by calling the WarehouseMaterialSearchEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOWarehouseMaterialAvailability>>	getMaterialAvailability(@Valid @NotNull DTOWarehouseMaterialAvailabilitySearchFilter filter)	Retrieves the required Warehouse Material Availability as required WarehouseMaterialAvailabilitySearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOWarehouseMaterialUpdate dto)	Modifies the required warehouse material by calling the WarehouseMaterialUpdateEvent.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOWarehouseMaterialInsert dto)	Creates a new warehouse material by calling the WarehouseMaterialInsertEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

WarehouseMaterialService

public WarehouseMaterialService()

Method Details

getCollection

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

Retrieves all the stored warehouse material by calling the WarehouseMaterialSearchEvent.

Parameters:

page - the Page that will contain the paginated result

filter - the DTOWarehouseMaterialSearchFilter

Returns:

the ResponseEntity containing the collection of DTOWarehouseMaterial

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required warehouse material by calling the WarehouseMaterialLoadEvent.

Parameters:

id - warehouse material id

Returns:

the ResponseEntity containing the loaded DTOWarehouseMaterial

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

Creates a new warehouse material by calling the WarehouseMaterialInsertEvent.

Parameters:

dto - the DTOWarehouseMaterialInsert

Returns:

the ResponseEntity containing the id of the inserted warehouse material

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

Modifies the required warehouse material by calling the WarehouseMaterialUpdateEvent.

Parameters:

id - the warehouse material id

dto - the DTOWarehouseMaterialUpdate

Returns:

the ResponseEntity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

activateWarehouseMaterial

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

Activates the warehouse material by calling the WarehouseMaterialActivateEvent.

Parameters:

id - the warehouse material id

Returns:

the ResponseEntity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

deactivateWarehouseMaterial

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

Deactivates the warehouse material by calling the WarehouseMaterialDeactivateEvent.

Parameters:

id - the warehouse material id

Returns:

the ResponseEntity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getMaterialAvailability

@GetMapping(value="actions/getMaterialAvailability",
            produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOWarehouseMaterialAvailability>> getMaterialAvailability(@RequestParam("filter") @Valid @NotNull
 @Valid @NotNull DTOWarehouseMaterialAvailabilitySearchFilter filter)
                                                                                                                throws DAValidateException,
DAException

Retrieves the required Warehouse Material Availability as required WarehouseMaterialAvailabilitySearchEvent.

Parameters:

filter - the DTOWarehouseMaterialAvailabilitySearchFilter

Returns:

the the ResponseEntity containing the collection of DTOWarehouseMaterialAvailability

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception