Package overit.geocallapp.wfm.workorders.rs1.status

Class WorkOrderStatusService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.workorders.rs1.status.WorkOrderStatusService

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

Service to manage work order status

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
WorkOrderStatusService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOWorkOrderStatus>	get(Long workOrderStatusId, Collection<String> fields)	Retrieves the required DTOWorkOrderStatus by calling the WorkOrderStatusLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOWorkOrderStatus>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOWorkOrderStatusFilter filter)	Returns the collection of all the stored work order status by calling the WorkOrderStatusSearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

WorkOrderStatusService

public WorkOrderStatusService()

Method Details

getCollection

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

Returns the collection of all the stored work order status by calling the WorkOrderStatusSearchEvent.

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 DTOWorkOrderStatusFilter

Returns:

the collection of DTOWorkOrderStatus

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOWorkOrderStatus by calling the WorkOrderStatusLoadEvent.

Parameters:

workOrderStatusId - the work order status id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded work order status

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception