Package overit.geocallapp.wfm.accounts.rs1.contacttype

Class AccountContactTypeService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.accounts.rs1.contacttype.AccountContactTypeService

@RestController
@RequestMapping("assets/accounts/r1/contact-types")
@Resource(logging=true)
public class AccountContactTypeService
extends PrivateService

Service to manage account contact types

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
AccountContactTypeService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOAccountContactType>	get(Long accountContactTypeId, Collection<String> fields)	Retrieves the required DTOAccountContactType by calling the ContactTypeLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOAccountContactType>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOAccountContactTypeFilter filter)	Returns the collection of all the stored account contact type by calling the ContactTypeSearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

AccountContactTypeService

public AccountContactTypeService()

Method Details

getCollection

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

Returns the collection of all the stored account contact type by calling the ContactTypeSearchEvent.

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 DTOAccountContactTypeFilter

Returns:

the collection of DTOAccountContactType

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOAccountContactType by calling the ContactTypeLoadEvent.

Parameters:

accountContactTypeId - the account type id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded account contact type

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception