Package overit.geocallapp.wfm.bundler.rs1.bundle

Class BundleService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.bundler.rs1.bundle.BundleService

@RestController
@RequestMapping("work-orders/bundler/r1/bundles")
@Resource(logging=true)
public class BundleService
extends PrivateService

Service to manage bundles.

Since:

21.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
BundleService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOBundle>	get(Long bundleId, Collection<String> fields)	Retrieves the required bundle by calling the BundleLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOBundle>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOBundleFilter filter)	Returns the collection of all the stored bundles by calling the BundleHeaderSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long bundleId, @Valid DTOBundleUpdate dto)	Update a bundle by calling the SchedulableBundleUpdateEvent

Methods inherited from class java.lang.Object

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

Constructor Details

BundleService

public BundleService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOBundle>> getCollection(@RequestParam("_page") @Valid
 @Valid Page page,
 @RequestParam(required=false,name="_fields")
 Collection<String> fields,
 @RequestParam(required=false,name="_order")
 String order,
 @Valid
 @Valid DTOBundleFilter filter)
                                                                               throws DAValidateException,
DAException

Returns the collection of all the stored bundles by calling the BundleHeaderSearchEvent.

Parameters:

page - the page that will contain the paginated result

fields - the collection of fields that will be contained in the response

order - the ordering field

filter - the DTOBundleFilter

Returns:

the collection of DTOBundles

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown

get

@GetMapping(value="{bundleId:[0-9]+}",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTOBundle> get(@PathVariable("bundleId")
 Long bundleId,
 @RequestParam(required=false,value="_fields")
 Collection<String> fields)
                                                       throws DAValidateException,
DAException

Retrieves the required bundle by calling the BundleLoadEvent.

Parameters:

bundleId - the ID of the bundle to be loaded

fields - the collection of fields that will be contained in the response

Returns:

the response containing the bundle

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown

patch

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

Update a bundle by calling the SchedulableBundleUpdateEvent

Parameters:

bundleId - the bundle id

dto - the DTOBundleUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception