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

Class TimesheetProfileService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.core.timesheet.rs2.config.profile.TimesheetProfileService

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

Services to manage the timesheet profile

Since:

19.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
TimesheetProfileService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOProfile>	get(Long id)	Retrieves the required profile ProfileLoadEvent
org.springframework.http.ResponseEntity<DTOProfile>	getByUser(@Valid Long userId)	Retrieves the required profile ProfileLoadByUserEvent
org.springframework.http.ResponseEntity<PageResponse<DTOProfile>>	getCollection(@Valid Page page, @Valid @NotNull DTOProfileSearchFilter filter)	Retrieve all the stored profiles ProfileSearchEvent
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOProfileUpdate dtoProfile)	Modifies the required profile.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOProfileInsert input)	Create a new profile.

Methods inherited from class java.lang.Object

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

Constructor Details

TimesheetProfileService

public TimesheetProfileService()

Method Details

get

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

Retrieves the required profile ProfileLoadEvent

Parameters:

id - profile

Returns:

the response containing the required profile

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getCollection

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

Retrieve all the stored profiles ProfileSearchEvent

Parameters:

page - the required result page

filter - the specified DTOProfileSearchFilter

Returns:

the response containing the current result page

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Modifies the required profile. ProfileUpdateEvent

Parameters:

id - the id

dtoProfile - the DTOProfileUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

post

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

Create a new profile. ProfileInsertEvent

Parameters:

input - the DTOProfileInsert

Returns:

the standard response containing the new profile id

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

getByUser

@GetMapping(value="actions/getbyuser",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTOProfile> getByUser(@RequestParam("userId") @Valid
 @Valid Long userId)
                                                              throws DAValidateException,
DAException

Retrieves the required profile ProfileLoadByUserEvent

Parameters:

userId -

Returns:

the response containing the profile by user

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception