Package overit.geocallapp.wfm.calendars.rs1.workshiftexceptionclass

Class WorkShiftExceptionClassService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.calendars.rs1.workshiftexceptionclass.WorkShiftExceptionClassService

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

Service to manage work shift exception classes.

Since:

17.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
WorkShiftExceptionClassService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOWorkShiftExceptionClass>	get(Long id, String language, Collection<String> fields)	Retrieves the required work shift exception class by calling the WorkShiftExceptionClassLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOWorkShiftExceptionClass>>	getCollection(@Valid Page page, String order, String language, Collection<String> fields, @Valid DTOWorkShiftExceptionClassFilter filter)	Returns the collection of all the stored work shift exception classes by calling the WorkShiftExceptionClassSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOWorkShiftExceptionClassUpdate input)	Updates the required work shift exception class by calling the WorkShiftExceptionClassUpdateEvent.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOWorkShiftExceptionClassInsert input)	Creates a new work shift exception class by calling the WorkShiftExceptionClassInsertEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

WorkShiftExceptionClassService

public WorkShiftExceptionClassService()

Method Details

getCollection

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

Returns the collection of all the stored work shift exception classes by calling the WorkShiftExceptionClassSearchEvent.

Parameters:

page - the page that will contain the paginated result

order - the ordering field

language - the user language

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

filter - the DTOWorkShiftExceptionClassFilter

Returns:

the collection of DTOWorkShiftExceptionClasss

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown

get

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

Retrieves the required work shift exception class by calling the WorkShiftExceptionClassLoadEvent.

Parameters:

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

language - the user language

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

Returns:

the response containing the loaded work shift exception class

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 DTOWorkShiftExceptionClassInsert input)
                                                                  throws DAValidateException,
DAException

Creates a new work shift exception class by calling the WorkShiftExceptionClassInsertEvent.

Parameters:

input - the DTOWorkShiftExceptionClassInsert

Returns:

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

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown

patch

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

Updates the required work shift exception class by calling the WorkShiftExceptionClassUpdateEvent.

Parameters:

id - the ID of the work shift exception class to be updated

input - the DTOWorkShiftExceptionClassUpdate

Returns:

the standard response

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown