Package overit.geocallapp.wfm.workorders.rs1.workcycle

Class WorkCycleService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.workorders.rs1.workcycle.WorkCycleService

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

Service for manage work cycle

Since:

18.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
WorkCycleService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOWorkCycle>	get(Long workCycleId, @Valid String language, Collection<String> fields)	Retrieves the required DTOWorkCycle by calling the WorkCycleLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOWorkCycle>>	getCollection(@Valid Page page, Collection<String> fields, String order, String language, @Valid @NotNull DTOWorkCycleFilter filter)	Returns the collection of all the stored work cycles by calling the WorkCycleSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long workCycleId, @Valid DTOWorkCycleUpdate dto)	Update a work cycle by calling the WorkCycleUpdateEvent
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOWorkCycleInsert dto)	Create a new work cycle by calling the WorkCycleInsertEvent

Methods inherited from class java.lang.Object

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

Constructor Details

WorkCycleService

public WorkCycleService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOWorkCycle>> getCollection(@RequestParam("_page") @Valid
 @Valid Page page,
 @RequestParam(required=false,name="_fields")
 Collection<String> fields,
 @RequestParam(required=false,name="_order")
 String order,
 @RequestParam(required=false,name="_language",defaultValue="user")
 String language,
 @Valid @NotNull
 @Valid @NotNull DTOWorkCycleFilter filter)
                                                                                  throws DAValidateException,
DAException

Returns the collection of all the stored work cycles by calling the WorkCycleSearchEvent.

Parameters:

page - the Page that will contain the paginated result

fields - the collection of fields the response will contain

order - the ordering field

language - the language for multilanguage fields

filter - the DTOWorkCycleFilter

Returns:

the collection of DTOWorkCycle

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOWorkCycle by calling the WorkCycleLoadEvent.

Parameters:

workCycleId - the work cycle id

language - the language for multilanguage fields

fields - the collection of fields the response will contain

Returns:

the response containing the loaded work cycle

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(@Valid @RequestBody
 @Valid DTOWorkCycleInsert dto)
                                                                  throws DAValidateException,
DAException

Create a new work cycle by calling the WorkCycleInsertEvent

Parameters:

dto - the DTOWorkCycleInsert

Returns:

the standard response containing the new work cycle id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Update a work cycle by calling the WorkCycleUpdateEvent

Parameters:

workCycleId - the work cycle id

dto - the DTOWorkCycleUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception