Package overit.geocallapp.wfm.scheduling.rs1.scheduling

Class SchedulingService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.scheduling.rs1.scheduling.SchedulingService

@RestController
@RequestMapping("scheduling/r1/schedule-work")
@Resource(logging=true)
public class SchedulingService
extends PrivateService

Service for manage scheduling

Since:

18.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
SchedulingService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOScheduling>	get(Long scheduleWorkId, Collection<String> fields)	Retrieves the required DTOScheduling by calling the SchedulingLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOScheduling>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid @NotNull DTOSchedulingFilter filter)	Returns the collection of all the stored DTOScheduling by calling the SchedulingSearchEvent.
org.springframework.http.ResponseEntity<DTOResourceWorkShiftTour>	getTourData(Long scheduleWorkId, Collection<String> fields)	Retrieves the tour data for the specified scheduling ID.

Methods inherited from class java.lang.Object

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

Constructor Details

SchedulingService

public SchedulingService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOScheduling>> getCollection(@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 DTOSchedulingFilter filter)
                                                                                   throws DAValidateException,
DAException

Returns the collection of all the stored DTOScheduling by calling the SchedulingSearchEvent.

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 DTOSchedulingFilter

Returns:

the collection of DTOScheduling

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOScheduling by calling the SchedulingLoadEvent.

Parameters:

scheduleWorkId - the schedule work id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded scheduling

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getTourData

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

Retrieves the tour data for the specified scheduling ID.

Parameters:

scheduleWorkId - The ID of the scheduling to retrieve the tour data for.

fields - The fields to include in the response, or null to include all fields.

Returns:

The tour data for the specified scheduling ID.

Throws:

DAValidateException - If there is a validation error.

DAException - If there is a data access error.