Package overit.geocallapp.wfm.workorders.rs1.origin

Class WorkOrderOriginService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.workorders.rs1.origin.WorkOrderOriginService

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

Service to manage work order origins

Since:

22.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
WorkOrderOriginService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOWorkOrderOrigin>	get(Long workOrderOriginId, Collection<String> fields)	Retrieves the required DTOWorkOrderOrigin by calling the WorkOrderOriginLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOWorkOrderOrigin>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOWorkOrderOriginFilter filter)	Returns the collection of all the stored work order origins by calling the WorkOrderOriginSearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

WorkOrderOriginService

public WorkOrderOriginService()

Method Details

getCollection

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

Returns the collection of all the stored work order origins by calling the WorkOrderOriginSearchEvent.

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 DTOWorkOrderOriginFilter

Returns:

the collection of DTOWorkOrderOrigin

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOWorkOrderOrigin by calling the WorkOrderOriginLoadEvent.

Parameters:

workOrderOriginId - the work order origin id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded work order origin

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception