Package overit.geocallapp.wfm.bundler.rs1.operation

Class BundleOperationService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.bundler.rs1.operation.BundleOperationService

@RestController
@RequestMapping("work-orders/bundler/r1/bundles/{bundleId:[0-9]+}/operations")
@Resource(logging=true)
public class BundleOperationService
extends PrivateService

Service to manage bundle operation.

Since:

21.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
BundleOperationService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOBundleOperation>	get(Long bundleId, Long operationId, Collection<String> fields)	Retrieves the required bundle operation by calling the BundleOperationLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOBundleOperation>>	getCollection(Long bundleId, @Valid Page page, Collection<String> fields, String order, @Valid DTOBundleOperationFilter filter)	Returns the collection of all the stored bundles operations by calling the BundleOperationSearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

BundleOperationService

public BundleOperationService()

Method Details

getCollection

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

Returns the collection of all the stored bundles operations by calling the BundleOperationSearchEvent.

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 DTOBundleOperationFilter

Returns:

the collection of DTOBundleOperations

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown

get

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

Retrieves the required bundle operation by calling the BundleOperationLoadEvent.

Parameters:

operationId - the ID of the bundle operation to be loaded

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

Returns:

the response containing the bundle operation

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown