Package overit.geocallapp.wfm.organizationalstructures.rs1.operationcenter

Class OperationCenterService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.organizationalstructures.rs1.operationcenter.OperationCenterService

@RestController
@RequestMapping("territory/organizational-structures/r1/operation-centers")
@Resource(logging=true)
public class OperationCenterService
extends PrivateService

Services to manage operation centers.

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
OperationCenterService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOOperationCenter>	get(Long id, String language, Collection<String> fields)	Retrieves the required operation center.
org.springframework.http.ResponseEntity<PageResponse<DTOOperationCenter>>	getCollection(@Valid Page page, String language, Collection<String> fields, String order, @Valid DTOOperationCenterSearchFilter filter)	Retrieve the all stored operation centers.
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid overit.geocallapp.wfm.organizationalstructures.rs1.operationcenter.DTOOperationCenterUpdate dto)	Modifies the required operation center.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOOperationCenterInsert dto)	Create a new operation center.

Methods inherited from class java.lang.Object

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

Constructor Details

OperationCenterService

public OperationCenterService()

Method Details

getCollection

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

Retrieve the all stored operation centers. OperationCenterSearchEvent

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 specified DTOOperationCenterSearchFilter

Returns:

the response containing the current result page

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required operation center. OperationCenterLoadEvent

Parameters:

id - operation center id

language - the user language

fields - the collection of fields the response will contain

Returns:

the response containing the required operation center

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

Create a new operation center. OperationCenterInsertEvent

Parameters:

dto - the DTOOperationCenter

Returns:

the standard response containing the new operation center id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Modifies the required operation center. OperationCenterUpdateEvent

Parameters:

id - the operation center id

dto - the DTOOperationCenterUpdate to update DTOOperationCenter

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception