Package overit.geocallapp.wfm.core.bundler.rs2.bundle.operation

Class BundleOperationService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.core.bundler.rs2.bundle.operation.BundleOperationService

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

Service to manage Bundle Operation.

Since:

19.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
BundleOperationService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	cancelOperation(Long id, Long operationId)	Action to cancel a specified operation from the bundle operations.
org.springframework.http.ResponseEntity<DTOBundleOperation>	get(Long id, Long operationId)	Retrieves the required bundle operation.
org.springframework.http.ResponseEntity<PageResponse<DTOBundleOperation>>	getCollection(@NotNull Long id, @NotNull @Valid Page page, @Valid @NotNull DTOBundleOperationSearchFilter filter)	Retrieves all the stored bundle operations.

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("id") @NotNull
 @NotNull Long id,
 @RequestParam("page") @NotNull @Valid
 @NotNull @Valid Page page,
 @RequestParam("filter") @Valid @NotNull
 @Valid @NotNull DTOBundleOperationSearchFilter filter)
                                                                                        throws DAValidateException,
DAException

Retrieves all the stored bundle operations. BundleOperationWoOperationSearchEvent

Parameters:

id - the id

page - the page

filter - the DTOBundleOperationSearchFilter

Returns:

the response containing the collection

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required bundle operation. BundleOperationLoadEvent

Parameters:

id - the id

operationId - the operation id

Returns:

the response containing the required DTO bundle operation

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

cancelOperation

@PostMapping(value="/{operationId}/actions/cancel",
             produces="application/json")
public org.springframework.http.ResponseEntity<Void> cancelOperation(@PathVariable("id")
 Long id,
 @PathVariable("operationId")
 Long operationId)
                                                              throws DAValidateException,
DAException

Action to cancel a specified operation from the bundle operations. BundleOperationCancelEvent

Parameters:

id - the id

operationId - the operation id

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception