Package overit.geocallapp.wfm.core.timesheet.rs2

Class TimesheetService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.core.timesheet.rs2.TimesheetService

@RestController
@RequestMapping("timesheet/r2")
@Resource(logging=true)
public class TimesheetService
extends PrivateService

Services to manage timesheet

Since:

19.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
TimesheetService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	close(Long id)	Action to close a timesheet TimesheetCloseEvent.
org.springframework.http.ResponseEntity<Void>	gapfiller(Long id, @Valid Collection<Long> shiftIds)	Action to call the timesheet gap filler TimesheetGapFillEvent.
org.springframework.http.ResponseEntity<DTOTimesheetHeader>	get(Long id)	Retrieves the required timesheet header.
org.springframework.http.ResponseEntity<PageResponse<DTOTimesheetHeader>>	getCollection(@Valid Page page, @Valid @NotNull DTOTimesheetSearchFilter filter)	Retrieve all the stored timesheet headers.
org.springframework.http.ResponseEntity<Collection<Long>>	insertTask(Long id, @NotNull @Valid DTOInsertTask input)	Action that inserts a task into a specific timesheet TimesheetTaskInsertEvent.
org.springframework.http.ResponseEntity<Collection<Long>>	insertTaskByUser(@NotNull @Valid DTOInsertTaskByUser input)	Action that inserts a task into the correct timesheet via the user id TimesheetTaskInsertEvent.
org.springframework.http.ResponseEntity<Void>	reopen(Long id)	Action to reopen a timesheet TimesheetReopenEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

TimesheetService

public TimesheetService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOTimesheetHeader>> getCollection(@RequestParam("page") @Valid
 @Valid Page page,
 @RequestParam("filter") @Valid @NotNull
 @Valid @NotNull DTOTimesheetSearchFilter filter)
                                                                                        throws DAValidateException,
DAException

Retrieve all the stored timesheet headers. TimesheetSearchEvent

Parameters:

page - the required result page

filter - the specified DTOTimesheetSearchFilter

Returns:

the response containing the current result page

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required timesheet header. TimesheetHeaderLoadEvent

Parameters:

id - the timesheet header id

Returns:

the response containing the required timesheet header

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

gapfiller

@PostMapping(value="/{id:[0-9]+}/actions/gapfill",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<Void> gapfiller(@PathVariable("id")
 Long id,
 @Valid @RequestBody
 @Valid Collection<Long> shiftIds)
                                                        throws DAException,
DAValidateException

Action to call the timesheet gap filler TimesheetGapFillEvent.

Parameters:

id - the id of the timesheet

shiftIds - the timesheet shift ids

Returns:

the DTO response

Throws:

DAException - if something went wrong

DAValidateException - the DA validate exception

See Also:

• TimesheetGapFillEvent

close

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

Action to close a timesheet TimesheetCloseEvent.

Parameters:

id - the id of the timesheet to close

Returns:

the DTO response

Throws:

DAException - if something went wrong

DAValidateException - the DA validate exception

See Also:

• TimesheetCloseEvent

reopen

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

Action to reopen a timesheet TimesheetReopenEvent.

Parameters:

id - the id of the timesheet to reopen

Returns:

the DTO response

Throws:

DAException - if something went wrong

DAValidateException - the DA validate exception

See Also:

• TimesheetReopenEvent

insertTask

@PostMapping(value="/{id:[0-9]+}/actions/inserttask",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<Collection<Long>> insertTask(@PathVariable("id")
 Long id,
 @NotNull @Valid @RequestBody
 @NotNull @Valid DTOInsertTask input)
                                                                     throws DAException,
DAValidateException

Action that inserts a task into a specific timesheet TimesheetTaskInsertEvent.

Parameters:

id - the timesheet id

input - the input dto DTOInsertTask

Returns:

the response containing the new timesheet task ids

Throws:

DAException - if something went wrong

DAValidateException - the DA validate exception

See Also:

• TimesheetTaskInsertEvent

insertTaskByUser

@PostMapping(value="/actions/inserttask",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<Collection<Long>> insertTaskByUser(@NotNull @Valid @RequestBody
 @NotNull @Valid DTOInsertTaskByUser input)
                                                                           throws DAException,
DAValidateException

Action that inserts a task into the correct timesheet via the user id TimesheetTaskInsertEvent.

Parameters:

input - the input dto DTOInsertTaskByUser

Returns:

the response containing the new timesheet task ids inserted by user

Throws:

DAException - if something went wrong

DAValidateException - the DA validate exception

See Also:

• TimesheetTaskInsertEvent