Package overit.geocallapp.wfm.accounts.rs1.status

Class AccountStatusService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.accounts.rs1.status.AccountStatusService

@RestController
@RequestMapping("assets/accounts/r1/status")
@Resource(logging=true)
public class AccountStatusService
extends PrivateService

Services to manage account status.

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
AccountStatusService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOAccountStatus>	get(Long id, String language, Collection<String> fields)	Retrieves the required account status.
org.springframework.http.ResponseEntity<PageResponse<DTOAccountStatus>>	getCollection(@Valid Page page, String language, Collection<String> fields, String order, @Valid DTOAccountStatusSearchFilter filter)	Retrieve the all stored account status.
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOAccountStatusUpdate input)	Modifies the required account status.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOAccountStatusInsert input)	Create a new account status.

Methods inherited from class java.lang.Object

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

Constructor Details

AccountStatusService

public AccountStatusService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOAccountStatus>> getCollection(@RequestParam("_page") @Valid
 @Valid Page page,
 @RequestParam(required=false,name="_language",defaultValue="user")
 String language,
 @RequestParam(required=false,name="_fields")
 Collection<String> fields,
 @RequestParam(required=false,name="_order")
 String order,
 @Valid
 @Valid DTOAccountStatusSearchFilter filter)
                                                                                      throws DAValidateException,
DAException

Retrieve the all stored account status. AccountStatusSearchEvent

Parameters:

page - the required result page

language - the user language

fields - the collection of fields the response will contain

order - the ordering field

filter - the DTOAccountStatusSearchFilter

Returns:

the response containing the current result page

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required account status. AccountStatusLoadEvent

Parameters:

id - technical object status id

language - the user language

fields - the collection of fields the response will contain

Returns:

the response containing the required account status

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 DTOAccountStatusInsert input)
                                                                  throws DAValidateException,
DAException

Create a new account status. AccountStatusInsertEvent

Parameters:

input - the DTOAccountStatusInsert

Returns:

a standard response containing the new account status id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Modifies the required account status. AccountStatusUpdateEvent

Parameters:

id - the account status id

input - the account status update DTOAccountStatusUpdate

Returns:

a standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception