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

Class TimesheetTaskService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.core.timesheet.rs2.task.TimesheetTaskService

@RestController
@RequestMapping("timesheet/r2/{id:[0-9]+}/tasks")
@Resource(logging=true)
public class TimesheetTaskService
extends PrivateService

Services to manage timesheet task

Since:

19.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
TimesheetTaskService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	cancel(Long timesheetId, Long taskId)	Action that cancels a timesheet task TimesheetTaskCancelEvent.
org.springframework.http.ResponseEntity<DTOTask>	get(Long id, Long taskId)	Retrieves the required timesheet task.
PageResponse<DTOTask>	getCollection(Long timesheetId)	Retrieve all the stored timesheet task.
org.springframework.http.ResponseEntity<Void>	update(Long timesheetId, Long taskId, @NotNull @Valid DTOTaskUpdate input)	Action that updates a timesheet task TaskUpdateEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

TimesheetTaskService

public TimesheetTaskService()

Method Details

getCollection

@GetMapping(produces="application/json")
public PageResponse<DTOTask> getCollection(@PathVariable("id")
 Long timesheetId)
                                    throws DAValidateException,
DAException

Retrieve all the stored timesheet task. TaskLoadEvent

Parameters:

timesheetId - the timesheet id

Returns:

the response containing the current result page

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required timesheet task. TaskLoadEvent

Parameters:

id - the timesheet id

taskId - the timesheet task id

Returns:

the response containing the required timesheet task

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

update

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

Action that updates a timesheet task TaskUpdateEvent.

Parameters:

timesheetId - the timesheet id

taskId - the timesheet task id

input - the input dto DTOTaskUpdate

Returns:

the DTO response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

See Also:

• TimesheetTaskUpdateEvent

cancel

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

Action that cancels a timesheet task TimesheetTaskCancelEvent.

Parameters:

timesheetId - the timesheet id

taskId - the timesheet task id

Returns:

the DTO response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

See Also:

• TimesheetTaskUpdateEvent