Package overit.geocallapp.wfm.accounts.rs1.account

Class AccountService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.accounts.rs1.account.AccountService

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

Service to manage accounts

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
AccountService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<List<DTOIdentifier<Long>>>	batchPost(@Size(min=1,max=200) @Valid List<DTOAccountBatchInsert> dtos)	Create a a list of accounts by calling the AccountInsertBatchEvent
org.springframework.http.ResponseEntity<DTOAccount>	get(Long accountId, Collection<String> fields)	Retrieves the required DTOAccount by calling the AccountLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOAccount>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOAccountFilter filter)	Returns the collection of all the stored accounts by calling the AccountSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long accountId, @Valid DTOAccountUpdate dto)	Update an account by calling the AccountUpdateEvent
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOAccountInsert dto)	Create a new account by calling the AccountInsertEvent

Methods inherited from class java.lang.Object

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

Constructor Details

AccountService

public AccountService()

Method Details

getCollection

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

Returns the collection of all the stored accounts by calling the AccountSearchEvent.

Parameters:

page - the Page that will contain the paginated result

fields - the collection of fields the response will contain

order - the ordering field

filter - the DTOAccountFilter

Returns:

the collection of DTOAccount

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOAccount by calling the AccountLoadEvent.

Parameters:

accountId - the account id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded account

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 DTOAccountInsert dto)
                                                                  throws DAValidateException,
DAException

Create a new account by calling the AccountInsertEvent

Parameters:

dto - the DTOAccountInsert

Returns:

the standard response containing the new account id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Update an account by calling the AccountUpdateEvent

Parameters:

accountId - the account id

dto - the DTOAccountUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

batchPost

@PostMapping(value="/batch",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<List<DTOIdentifier<Long>>> batchPost(@Size(min=1,max=200) @Valid @RequestBody
 @Size(min=1,max=200) @Valid List<DTOAccountBatchInsert> dtos)
                                                                             throws DAValidateException,
DAException

Create a a list of accounts by calling the AccountInsertBatchEvent

Parameters:

dtos - the list of DTOAccountBatchInsert

Returns:

the standard response containing the list of new account ids

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception