Package overit.geocallapp.wfm.core.rs5.user

Class UserService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.core.rs5.user.UserService

@RestController
@RequestMapping("core/r5/users")
@Resource(logging=true)
public class UserService
extends PrivateService

Services to manage users.

Since:

19.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
UserService()

Method Summary

Modifier and Type	Method	Description
DTOUser	get(Long id)	Retrieves the required user.
PageResponse<DTOUser>	getCollection(@NotNull @Valid Page page, @Valid @NotNull DTOUserSearchFilter filter)	Retrieve the all stored users.
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOUserUpdate dtoUser)	Modifies the required user.
org.springframework.http.ResponseEntity<Long>	post(@Valid DTOUserInsert dtoUser)	Create a new user.

Methods inherited from class java.lang.Object

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

Constructor Details

UserService

public UserService()

Method Details

getCollection

@GetMapping(produces="application/json")
public PageResponse<DTOUser> getCollection(@RequestParam("page") @NotNull @Valid
 @NotNull @Valid Page page,
 @RequestParam("filter") @Valid @NotNull
 @Valid @NotNull DTOUserSearchFilter filter)
                                    throws DAValidateException,
DAException

Retrieve the all stored users. UserSearchEvent

Parameters:

page - the required result page

filter - the specified DTOUserSearchFilter

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 DTOUser get(@PathVariable("id")
 Long id)
            throws DAValidateException,
DAException

Retrieves the required user. LoadUserEvent

Parameters:

id - user id

Returns:

the response containing the required user

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

post

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

Create a new user. CreateUserEvent

Parameters:

dtoUser - the DTOUserInsert

Returns:

a standard response containing the new user id

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 DTOUserUpdate dtoUser)
                                                    throws DAValidateException,
DAException

Modifies the required user. UpdateUserEvent

Parameters:

id - the user id

dtoUser - the user update DTOUserUpdate

Returns:

a standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception