Package overit.geocallapp.wfm.workorders.rs1.operation

Class WorkOrderOperationService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.workorders.rs1.operation.WorkOrderOperationService

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

Service to manage work order operation

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
WorkOrderOperationService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	batchPatch(Long workOrderId, @Size(min=1,max=100) @Valid List<DTOWorkOrderOperationBatchUpdate> batchInput)	Update a batch of work order operations by calling the WorkOrderOperationUpdateBatchEvent
org.springframework.http.ResponseEntity<List<DTOIdentifier<Long>>>	batchPost(Long workOrderId, @Size(min=1,max=100) @Valid List<DTOWorkOrderOperationInsert> batchInput)	Create a batch of work order operations by calling the WorkOrderOperationInsertBatchEvent
org.springframework.http.ResponseEntity<Void>	cancel(Long workOrderId, Long operationId)	Cancel the association between the work order and the work order operation by calling the WorkOrderCancelEvent.
org.springframework.http.ResponseEntity<DTOWorkOrderOperation>	get(Long workOrderId, Long operationId, Collection<String> fields)	Retrieves the required DTOWorkOrderOperation by calling the WorkOrderOperationLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOWorkOrderOperation>>	getCollection(Long workOrderId, @Valid Page page, Collection<String> fields, String order, @Valid DTOWorkOrderOperationFilter filter)	Returns the collection of all the stored work order operations by calling the WorkOrderOperationSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long workOrderId, Long operationId, @Valid DTOWorkOrderOperationUpdate dto)	Update a work order operation by calling the WorkOrderOperationUpdateEvent
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(Long workOrderId, @Valid DTOWorkOrderOperationInsert dto)	Create a new work order operation by calling the WorkOrderOperationInsertEvent

Methods inherited from class java.lang.Object

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

Constructor Details

WorkOrderOperationService

public WorkOrderOperationService()

Method Details

getCollection

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

Returns the collection of all the stored work order operations by calling the WorkOrderOperationSearchEvent.

Parameters:

workOrderId - the work order id

page - the Page that will contain the paginated result

fields - the collection of fields the response will contain

order - the ordering field

filter - the DTOWorkOrderOperationFilter

Returns:

the collection of DTOWorkOrderOperation

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOWorkOrderOperation by calling the WorkOrderOperationLoadEvent.

Parameters:

workOrderId - the work order id

operationId - the operation id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded work order operation

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

post

@PostMapping(consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<DTOIdentifier<Long>> post(@PathVariable("workOrderId")
 Long workOrderId,
 @Valid @RequestBody
 @Valid DTOWorkOrderOperationInsert dto)
                                                                  throws DAValidateException,
DAException

Create a new work order operation by calling the WorkOrderOperationInsertEvent

Parameters:

workOrderId - the work order id

dto - the DTOWorkOrderOperationInsert

Returns:

the standard response containing the new work order operation id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Update a work order operation by calling the WorkOrderOperationUpdateEvent

Parameters:

workOrderId - the work order id

operationId - the operation id

dto - the DTOWorkOrderOperationUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

cancel

@PostMapping(value="/{operationId:[0-9]+}/cancellations",
             produces="application/json")
public org.springframework.http.ResponseEntity<Void> cancel(@PathVariable("workOrderId")
 Long workOrderId,
 @PathVariable("operationId")
 Long operationId)
                                                     throws DAException,
DAValidateException

Cancel the association between the work order and the work order operation by calling the WorkOrderCancelEvent.

Parameters:

workOrderId - the work order id

operationId - the work order operation id

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

batchPost

@PostMapping(value="/batch",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<List<DTOIdentifier<Long>>> batchPost(@PathVariable("workOrderId")
 Long workOrderId,
 @Size(min=1,max=100) @Valid @RequestBody
 @Size(min=1,max=100) @Valid List<DTOWorkOrderOperationInsert> batchInput)
                                                                             throws DAValidateException,
DAException

Create a batch of work order operations by calling the WorkOrderOperationInsertBatchEvent

Parameters:

batchInput - a list of DTOWorkOrderOperationInsert

Returns:

the standard response containing the list of new work order operation ids

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

batchPatch

@PatchMapping(value="/batch",
              consumes="application/json",
              produces="application/json")
public org.springframework.http.ResponseEntity<Void> batchPatch(@PathVariable("workOrderId")
 Long workOrderId,
 @Size(min=1,max=100) @RequestBody @Valid
 @Size(min=1,max=100) @Valid List<DTOWorkOrderOperationBatchUpdate> batchInput)
                                                         throws DAValidateException,
DAException

Update a batch of work order operations by calling the WorkOrderOperationUpdateBatchEvent

Parameters:

batchInput - a list of DTOWorkOrderOperationBatchUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception