Package overit.geocallapp.wfm.calendars.rs1.workshiftexceptionmanagement

Class WorkShiftExceptionManagementService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.calendars.rs1.workshiftexceptionmanagement.WorkShiftExceptionManagementService

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

Service to manage work shift exception managements.

Since:

17.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
WorkShiftExceptionManagementService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOWorkShiftExceptionManagement>	get(Long id, Collection<String> fields)	Retrieves the required work shift exception management by calling the WorkShiftExceptionManagementLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOWorkShiftExceptionManagement>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOWorkShiftExceptionManagementFilter filter)	Returns the collection of all the stored work shift exception managements by calling the WorkShiftExceptionManagementSearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

WorkShiftExceptionManagementService

public WorkShiftExceptionManagementService()

Method Details

getCollection

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

Returns the collection of all the stored work shift exception managements by calling the WorkShiftExceptionManagementSearchEvent.

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 DTOWorkShiftExceptionManagementFilter

Returns:

the collection of DTOWorkShiftExceptionManagements

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown

get

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

Retrieves the required work shift exception management by calling the WorkShiftExceptionManagementLoadEvent.

Parameters:

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

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

Returns:

the response containing the loaded work shift exception management

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown