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

Class BundleOperationOrderingService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.bundler.rs1.operation.ordering.BundleOperationOrderingService

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

Service to manage bundle operation ordering.

Since:

20.1

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
BundleOperationOrderingService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOBundleOperationOrdering>	get(Long orderingId, Collection<String> fields)	Retrieves the required bundle operation ordering by calling the BundleOperationOrderingLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOBundleOperationOrdering>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOBundleOperationOrderingFilter filter)	Returns the collection of all the stored bundles operation orderings by calling the BundleOperationOrderingSearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

BundleOperationOrderingService

public BundleOperationOrderingService()

Method Details

getCollection

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

Returns the collection of all the stored bundles operation orderings by calling the BundleOperationOrderingSearchEvent.

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 DTOBundleOperationOrderingFilter

Returns:

the collection of DTOBundleOperationOrderings

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown

get

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

Retrieves the required bundle operation ordering by calling the BundleOperationOrderingLoadEvent.

Parameters:

orderingId - the ID of the bundle operation ordering 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