Package overit.geocallapp.wfm.workorders.rs1.workcyclestructure

Class WorkCycleStructureService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.workorders.rs1.workcyclestructure.WorkCycleStructureService

@RestController
@RequestMapping("work-orders/r1/work-cycles/{workCycleId:[0-9]+}/structures")
@Resource(logging=true)
public class WorkCycleStructureService
extends PrivateService

Service for manage work cycle structure

Since:

18.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
WorkCycleStructureService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	delete(Long workCycleId, Long workCycleStructureId)	Remove a work cycle structure by calling the WorkCycleStructureDeleteEvent.
org.springframework.http.ResponseEntity<DTOWorkCycleStructure>	get(Long workCycleId, Long workCycleStructureId, Collection<String> fields)	Retrieves the required DTOWorkCycleStructure by calling the WorkCycleStructureLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOWorkCycleStructure>>	getCollection(Long workCycleId, @Valid Page page, Collection<String> fields, String order, @Valid @NotNull DTOWorkCycleStructureFilter filter)	Retrieve the all stored work cycle structures.

Methods inherited from class java.lang.Object

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

Constructor Details

WorkCycleStructureService

public WorkCycleStructureService()

Method Details

getCollection

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

Retrieve the all stored work cycle structures. WorkCycleStructureSearchEvent

Parameters:

workCycleId - the work cycle id

page - the required result Page

fields - the collection of fields the response will contain

order - the ordering field

filter - the DTOWorkCycleStructureFilter

Returns:

the response containing the current result page

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOWorkCycleStructure by calling the WorkCycleStructureLoadEvent.

Parameters:

workCycleId - the work cycle id

workCycleStructureId - the work cycle structure id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded work cycle structure

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

delete

@DeleteMapping(value="{workCycleStructureId:[0-9]+}",
               produces="application/json")
public org.springframework.http.ResponseEntity<Void> delete(@PathVariable("workCycleId")
 Long workCycleId,
 @PathVariable("workCycleStructureId")
 Long workCycleStructureId)
                                                     throws DAValidateException,
DAException

Remove a work cycle structure by calling the WorkCycleStructureDeleteEvent.

Parameters:

workCycleId - the work cycle id

workCycleStructureId - the work cycle structure id

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception