Class BTGPSTimedPositionSearch
java.lang.Object
overit.geocall.bl.BusinessTask<TimedGPSPositionSearchEvent>
overit.geocallapp.utilities.core.bl.common.validexecution.ValidExecutionBusinessTask<TimedGPSPositionSearchEvent>
overit.geocallapp.utilities.core.bl.common.validexecution.ValidPermissionBusinessTask<TimedGPSPositionSearchEvent>
overit.geocallapp.wfm.gpstracking.rc1.position.task.BTGPSTimedPositionSearch
- All Implemented Interfaces:
Serializable,Tool,ValidExecution
@Event(TimedGPSPositionSearchEvent.class)
public class BTGPSTimedPositionSearch
extends ValidPermissionBusinessTask<TimedGPSPositionSearchEvent>
Business task for searching timed GPS positions.
The task retrieves timed GPS position data for a specific resource by calling an external REST service if the endpoint was correctly configured in the company properties (see
The task retrieves timed GPS position data for a specific resource by calling an external REST service if the endpoint was correctly configured in the company properties (see
PropertiesGPSTracking.GPSTimedPosition.getGPSTimedPositionEndpoint()). - Since:
- 22.0
- See Also:
- GCApi:
- task
-
Field Summary
FieldsFields inherited from class overit.geocallapp.utilities.core.bl.common.validexecution.ValidPermissionBusinessTask
LOG -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidexecute(TimedGPSPositionSearchEvent event, PoolKit poolKit) Executes the timed GPS position search operation.booleanDetermines whether the current state is valid for execution.protected PageResponse<TimedGPSPosition> Loads timed GPS positions from an external REST service, if configured.Prepares the filters for the timed GPS position search.Methods inherited from class overit.geocallapp.utilities.core.bl.common.validexecution.ValidPermissionBusinessTask
checkValidExecution, getException, throwExceptionIfInvalidMethods inherited from class overit.geocallapp.utilities.core.bl.common.validexecution.ValidExecutionBusinessTask
body, getEventMethods inherited from class overit.geocall.bl.BusinessTask
start, start, startAlone, startInBackground
-
Field Details
-
CONFIG_NAME
- See Also:
-
-
Constructor Details
-
BTGPSTimedPositionSearch
public BTGPSTimedPositionSearch()
-
-
Method Details
-
execute
protected void execute(TimedGPSPositionSearchEvent event, PoolKit poolKit) throws DAException, DAValidateException Executes the timed GPS position search operation. This method retrieves timed GPS position data for a specific resource by calling an external REST service.- Specified by:
executein classValidExecutionBusinessTask<TimedGPSPositionSearchEvent>- Parameters:
event- TheTimedGPSPositionSearchEventcontaining the search filterpoolKit- ThePoolKitproviding access to the data layer- Throws:
DAException- If a data access error occurs during the operationDAValidateException- If validation of the data fails
-
loadGPSTimedPositions
protected PageResponse<TimedGPSPosition> loadGPSTimedPositions(TimedGPSPositionSearchFilter filter) throws DAValidateException Loads timed GPS positions from an external REST service, if configured. This method retrieves timed GPS position data for a specific resource by calling an external REST service, if the endpoint was correctly configured in the company properties.- Parameters:
filter- TheTimedGPSPositionSearchFiltercontaining the search filter- Returns:
- A
PageResponsecontaining the retrieved timed GPS positions - Throws:
DAValidateException- If validation of the data fails
-
prepareFilters
Prepares the filters for the timed GPS position search.- Parameters:
filter- TheTimedGPSPositionSearchFiltercontaining the search filter- Returns:
- A map containing the prepared filters
-
isValidExecution
public boolean isValidExecution()Description copied from interface:ValidExecutionDetermines whether the current state is valid for execution.- Returns:
- true if execution is valid, false otherwise
-