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

Class WorkOrderOperationDirectService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.workorders.rs1.operation.WorkOrderOperationDirectService

@RestController
@RequestMapping("work-orders/r1/operations")
@Resource(logging=true)
public class WorkOrderOperationDirectService
extends PrivateService

Service to manage the operation by using direct access without work order id

Since:

18.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
WorkOrderOperationDirectService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOWorkOrderOperation>	get(Long operationId, Collection<String> fields)	Retrieves the required DTOWorkOrderOperation by calling the WorkOrderOperationLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOWorkOrderOperation>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOWorkOrderOperationFilter filter)	Returns the collection of all the stored operations by calling the WorkOrderOperationSearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

WorkOrderOperationDirectService

public WorkOrderOperationDirectService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOWorkOrderOperation>> getCollection(@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 operations by calling the WorkOrderOperationSearchEvent.

Parameters:

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("operationId")
 Long operationId,
 @RequestParam(required=false,value="_fields")
 Collection<String> fields)
                                                                   throws DAValidateException,
DAException

Retrieves the required DTOWorkOrderOperation by calling the WorkOrderOperationLoadEvent.

Parameters:

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