Package overit.geocallapp.wfm.gpstracking.rs1.resource.position

Class ResourcePositionService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.gpstracking.rs1.resource.position.ResourcePositionService

@RestController
@RequestMapping("tracking/gps-tracking/r1/resource-positions")
@Resource(logging=true)
public class ResourcePositionService
extends PrivateService

Service to manage resource GPS position.

Since:

22.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ResourcePositionService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOResourcePosition>	get(Long resourcePositionId, Collection<String> fields)	Retrieves the required DTOResourcePosition by calling the ResourceGPSPositionLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOResourcePosition>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid @NotNull DTOResourcePositionFilter filter)	Returns the collection of all the stored resource GPS positions by calling the ResourceGPSPositionSearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

ResourcePositionService

public ResourcePositionService()

Method Details

getCollection

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

Returns the collection of all the stored resource GPS positions by calling the ResourceGPSPositionSearchEvent.

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 DTOResourcePositionFilter

Returns:

the collection of DTOResourcePosition

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOResourcePosition by calling the ResourceGPSPositionLoadEvent.

Parameters:

resourcePositionId - the resource GPS position id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded resource GPS position

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception