Package overit.geocallapp.wfm.calendars.rs1.workshiftexceptionimpact

Class WorkShiftExceptionImpactService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.calendars.rs1.workshiftexceptionimpact.WorkShiftExceptionImpactService

@RestController
@RequestMapping("workforce/calendars/r1/work-shift-exception-impacts")
@Resource(logging=true)
public class WorkShiftExceptionImpactService
extends PrivateService

Service to manage work shift exception impacts.

Since:

17.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
WorkShiftExceptionImpactService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOWorkShiftExceptionImpact>	get(Long id, Collection<String> fields)	Retrieves the required work shift exception impact by calling the WorkShiftExceptionImpactLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOWorkShiftExceptionImpact>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOWorkShiftExceptionImpactFilter filter)	Returns the collection of all the stored work shift exception impacts by calling the WorkShiftExceptionImpactSearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

WorkShiftExceptionImpactService

public WorkShiftExceptionImpactService()

Method Details

getCollection

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

Returns the collection of all the stored work shift exception impacts by calling the WorkShiftExceptionImpactSearchEvent.

Parameters:

page - the page that will contain the paginated result

fields - the collection of fields that will be contained in the response

order - the ordering field

filter - the DTOWorkShiftExceptionImpactFilter

Returns:

the collection of DTOWorkShiftExceptionImpacts

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown

get

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

Retrieves the required work shift exception impact by calling the WorkShiftExceptionImpactLoadEvent.

Parameters:

id - the ID of the work shift exception impact to be loaded

fields - the collection of fields that will be contained in the response

Returns:

the response containing the loaded work shift exception impact

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown