Package overit.geocallapp.wfm.systemsettings.rs1.externalsystem

Class ExternalSystemService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.systemsettings.rs1.externalsystem.ExternalSystemService

@RestController
@RequestMapping("configurations/system-settings/r1/external-systems")
@Resource(logging=true)
public class ExternalSystemService
extends PrivateService

Service to manage external system

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ExternalSystemService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOExternalSystem>	get(Long id, Collection<String> fields)	Retrieves the required DTOExternalSystem by calling the ExternalSystemLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOExternalSystem>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOExternalSystemFilter filter)	Returns the collection of all the stored external system by calling the ExternalSystemSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOExternalSystemUpdate dto)	Update an external system by calling the ExternalSystemUpdateEvent
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOExternalSystemInsert dto)	Create a new external system by calling the ExternalSystemInsertEvent

Methods inherited from class java.lang.Object

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

Constructor Details

ExternalSystemService

public ExternalSystemService()

Method Details

getCollection

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

Returns the collection of all the stored external system by calling the ExternalSystemSearchEvent.

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 DTOExternalSystemFilter

Returns:

the collection of DTOExternalSystem

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOExternalSystem by calling the ExternalSystemLoadEvent.

Parameters:

id - the external system id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded external system

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

Create a new external system by calling the ExternalSystemInsertEvent

Parameters:

dto - the DTOExternalSystemInsert

Returns:

the standard response containing the new external system id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Update an external system by calling the ExternalSystemUpdateEvent

Parameters:

id - the external system id

dto - the DTOExternalSystemUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception