Package overit.geocallapp.wfm.calendars.rs1.workshiftexception

Class WorkShiftExceptionService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.calendars.rs1.workshiftexception.WorkShiftExceptionService

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

Service to manage work shift exceptions.

Since:

17.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
WorkShiftExceptionService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	batchDelete(@Size(min=1,max=50) Collection<Long> ids)	Delete a batch of work shift exceptions, by calling the WorkShiftExceptionDeleteBatchEvent.
org.springframework.http.ResponseEntity<Void>	batchPatch(@Size(min=1,max=50) @Valid List<DTOWorkShiftExceptionBatchUpdate> batchInput)	Update a batch of work shift exceptions by calling the WorkShiftExceptionUpdateBatchEvent
org.springframework.http.ResponseEntity<List<DTOIdentifier<Long>>>	batchPost(@Size(min=1,max=50) @Valid List<DTOWorkShiftExceptionInsert> dtos)	Creates a set of new work shift exceptions by calling the WorkShiftExceptionInsertBatchEvent
org.springframework.http.ResponseEntity<Void>	delete(Long workShiftExceptionId)
org.springframework.http.ResponseEntity<DTOWorkShiftException>	get(Long workShiftExceptionId, Collection<String> fields)	Retrieves the required work shift exception by calling the WorkShiftExceptionLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOWorkShiftException>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOWorkShiftExceptionFilter filter)	Returns the collection of all the stored work shift exceptions by calling the WorkShiftExceptionSearchEvent.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOWorkShiftExceptionInsert dto)	Creates a new work shift exception by calling the WorkShiftExceptionInsertEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

WorkShiftExceptionService

public WorkShiftExceptionService()

Method Details

getCollection

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

Returns the collection of all the stored work shift exceptions by calling the WorkShiftExceptionSearchEvent.

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 DTOWorkShiftExceptionFilter

Returns:

the collection of DTOWorkShiftExceptions

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown

get

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

Retrieves the required work shift exception by calling the WorkShiftExceptionLoadEvent.

Parameters:

workShiftExceptionId - the ID of the work shift exception to be loaded

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

Returns:

the response containing the loaded work shift exception

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown

post

@PostMapping(consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<DTOIdentifier<Long>> post(@Valid @RequestBody
 @Valid DTOWorkShiftExceptionInsert dto)
                                                                  throws DAValidateException,
DAException

Creates a new work shift exception by calling the WorkShiftExceptionInsertEvent.

Parameters:

dto - the DTOWorkShiftExceptionInsert

Returns:

the response containing the ID of the newly created work shift exception

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown

delete

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

Throws:

DAValidateException

DAException

batchPost

@PostMapping(value="/batch",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<List<DTOIdentifier<Long>>> batchPost(@Size(min=1,max=50) @Valid @RequestBody
 @Size(min=1,max=50) @Valid List<DTOWorkShiftExceptionInsert> dtos)
                                                                             throws DAValidateException,
DAException

Creates a set of new work shift exceptions by calling the WorkShiftExceptionInsertBatchEvent

Parameters:

dtos - list of DTOWorkShiftExceptionInsert

Returns:

the response containing the IDs of the newly created work shift exceptions

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

batchPatch

@PatchMapping(value="/batch",
              consumes="application/json",
              produces="application/json")
public org.springframework.http.ResponseEntity<Void> batchPatch(@Size(min=1,max=50) @RequestBody @Valid
 @Size(min=1,max=50) @Valid List<DTOWorkShiftExceptionBatchUpdate> batchInput)
                                                         throws DAValidateException,
DAException

Update a batch of work shift exceptions by calling the WorkShiftExceptionUpdateBatchEvent

Parameters:

batchInput - a list of DTOWorkShiftExceptionBatchUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

batchDelete

@DeleteMapping(value="/batch",
               consumes="application/json",
               produces="application/json")
public org.springframework.http.ResponseEntity<Void> batchDelete(@Size(min=1,max=50) @RequestParam(name="id")
 @Size(min=1,max=50) Collection<Long> ids)
                                                          throws DAValidateException,
DAException

Delete a batch of work shift exceptions, by calling the WorkShiftExceptionDeleteBatchEvent.

Parameters:

ids - the collection of work shift exception ids to be deleted

Returns:

the empty response entity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception