From 236efd58623f7fc8372fb760695fafd72dff7bf7 Mon Sep 17 00:00:00 2001 From: Christoph Weitkamp Date: Thu, 16 Jul 2020 21:02:04 +0200 Subject: [PATCH] Clarification in JavaDoc about QueryablePersistenceService methods (#1552) Signed-off-by: Christoph Weitkamp --- .../core/persistence/QueryablePersistenceService.java | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/bundles/org.openhab.core.persistence/src/main/java/org/openhab/core/persistence/QueryablePersistenceService.java b/bundles/org.openhab.core.persistence/src/main/java/org/openhab/core/persistence/QueryablePersistenceService.java index 18508da38c..0488028c7f 100644 --- a/bundles/org.openhab.core.persistence/src/main/java/org/openhab/core/persistence/QueryablePersistenceService.java +++ b/bundles/org.openhab.core.persistence/src/main/java/org/openhab/core/persistence/QueryablePersistenceService.java @@ -28,7 +28,7 @@ import org.openhab.core.items.Item; public interface QueryablePersistenceService extends PersistenceService { /** - * Queries the {@link PersistenceService} for data with a given filter criteria + * Queries the {@link PersistenceService} for historic data with a given {@link FilterCriteria}. * * @param filter the filter to apply to the query * @return a time series of items @@ -36,12 +36,11 @@ public interface QueryablePersistenceService extends PersistenceService { Iterable query(FilterCriteria filter); /** - * Returns a list of items that are stored in the persistence service + * Returns a set of {@link PersistenceItemInfo} about items that are stored in the persistence service. This allows + * the persistence service to return information about items that are no long available as an {@link Item} in + * openHAB. If it is not possible to retrieve the information an empty set should be returned. * - * This is returned as a string to allow the persistence service to return items that are no long available as an - * {@link Item}. - * - * @return list of strings of item names contained in the store. Not null. + * @return a set of information about the persisted items */ Set getItemInfo(); }