Package overit.geocallapp.wfm.timesheets.rs1.clockings

Class ClockingService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.timesheets.rs1.clockings.ClockingService

@RestController
@RequestMapping("workforce/timesheets/r1/clockings")
@Resource(logging=true)
public class ClockingService
extends PrivateService

Service to manage clockings.

Since:

17.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ClockingService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOClocking>	get(Long id, Collection<String> fields)	Retrieves the required clocking by calling the ClockingLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOClocking>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOClockingFilter filter)	Returns the collection of all the stored clockings by calling the ClockingSearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

ClockingService

public ClockingService()

Method Details

getCollection

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

Returns the collection of all the stored clockings by calling the ClockingSearchEvent.

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 DTOClockingFilter

Returns:

the collection of DTOClockings

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown

get

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

Retrieves the required clocking by calling the ClockingLoadEvent.

Parameters:

id - the ID of the clocking to be loaded

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

Returns:

the response containing the loaded clocking

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown