Package overit.geocallapp.wfm.resources.rs1.resourcemanagement

Class ResourceManagementService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.resources.rs1.resourcemanagement.ResourceManagementService

@RestController
@RequestMapping("workforce/resources/r1/resource-managements")
@Resource(logging=true)
public class ResourceManagementService
extends PrivateService

Service to manage resource management

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ResourceManagementService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOResourceManagement>	get(Long id, Collection<String> fields)	Retrieves the required DTOResourceManagement by calling the ResourceManagementLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOResourceManagement>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOResourceManagementFilter filter)	Returns the collection of all the stored resource managements by calling the ResourceManagementSearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

ResourceManagementService

public ResourceManagementService()

Method Details

getCollection

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

Returns the collection of all the stored resource managements by calling the ResourceManagementSearchEvent.

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 DTOResourceManagementFilter

Returns:

the collection of DTOResourceManagement

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOResourceManagement by calling the ResourceManagementLoadEvent.

Parameters:

id - the resource management id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded resource management

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception