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

Class BundleOperationStatusService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.bundler.rs1.operation.status.BundleOperationStatusService

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

Service to manage Bundle Operation Status.

Since:

20.1

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
BundleOperationStatusService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOBundleOperationStatus>	get(Long statusId, Collection<String> fields)	Retrieves the required bundle operation status by calling the BundleOperationStatusLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOBundleOperationStatus>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOBundleOperationStatusFilter filter)	Returns the collection of all the stored bundle operation status by calling the BundleOperationStatusSearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

BundleOperationStatusService

public BundleOperationStatusService()

Method Details

getCollection

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

Returns the collection of all the stored bundle operation status by calling the BundleOperationStatusSearchEvent.

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 DTOBundleOperationStatusFilter

Returns:

the collection of DTOBundleOperationStatuses

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown

get

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

Retrieves the required bundle operation status by calling the BundleOperationStatusLoadEvent.

Parameters:

statusId - the ID of the bundle operation status to be loaded

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

Returns:

the response containing the bundle operation ordering

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown