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

Class MobileWarehouseService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.inventory.rs2.warehouse.mobile.MobileWarehouseService

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

Services to manage mobile warehouses.

Since:

19.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
MobileWarehouseService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	activate(Long id)	Activates the required mobile warehouse.
org.springframework.http.ResponseEntity<Void>	associateSchedulingResource(Long id, Long idSchedulingResource)	Associates the scheduling resource to the mobile warehouse.
org.springframework.http.ResponseEntity<Void>	dissociateSchedulingResource(Long id)	Dissociate scheduling resource.
org.springframework.http.ResponseEntity<DTOMobileWarehouse>	get(Long id, String language)	Retrieves the required mobile warehouse.
org.springframework.http.ResponseEntity<PageResponse<DTOMobileWarehouse>>	getCollection(@NotNull @Valid Page page, @Valid @NotNull DTOMobileWarehouseSearchFilter filter)	Retrieves all the stored mobile warehouses.
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOMobileWarehouseUpdate dto)	Modifies the required mobile warehouse.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOMobileWarehouseInsert dto)	Create a new mobile warehouse.

Methods inherited from class java.lang.Object

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

Constructor Details

MobileWarehouseService

public MobileWarehouseService()

Method Details

getCollection

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

Retrieves all the stored mobile warehouses. MobileWarehouseSearchEvent

Parameters:

page - the Page that will contain the paginated result

filter - the DTOMobileWarehouseSearchFilter

Returns:

the response containing the collection

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required mobile warehouse. MobileWarehouseLoadEvent

Parameters:

id - response id

language - the language

Returns:

the response containing the required mobile warehouse

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

Create a new mobile warehouse. MobileWarehouseInsertEvent

Parameters:

dto - the DTOMobileWarehouseInsert

Returns:

the DTO response containing the new mobile warehouse's 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 DTOMobileWarehouseUpdate dto)
                                                    throws DAValidateException,
DAException

Modifies the required mobile warehouse. MobileWarehouseUpdateEvent

Parameters:

id - the id

dto - the DTOMobileWarehouseUpdate

Returns:

the DTO response

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 mobile warehouse. MobileWarehouseActivateEvent

Parameters:

id - the id

Returns:

the DTO response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

associateSchedulingResource

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

Associates the scheduling resource to the mobile warehouse. MobileWarehouseSchedulingResourceAssociationEvent

Parameters:

id - the id

idSchedulingResource - the id scheduling resource

Returns:

the DTO response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

dissociateSchedulingResource

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

Dissociate scheduling resource. MobileWarehouseSchedulingResourceRemoveEvent

Parameters:

id - the id

Returns:

the DTO response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception