OpenHAB
/
openhab-core
mirror of https://github.com/openhab/openhab-core.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Clarification in JavaDoc about QueryablePersistenceService methods (#1552) 

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
pull/1553/head
Christoph Weitkamp 2020-07-16 21:02:04 +02:00 committed by GitHub
parent 729efeb37a
commit 236efd5862
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
bundles/org.openhab.core.persistence/src/main/java/org/openhab/core/persistence/QueryablePersistenceService.java
View File

@ -28,7 +28,7 @@ import org.openhab.core.items.Item;
public interface QueryablePersistenceService extends PersistenceService { 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 * @param filter the filter to apply to the query
* @return a time series of items * @return a time series of items
@ -36,12 +36,11 @@ public interface QueryablePersistenceService extends PersistenceService {
Iterable<HistoricItem> query(FilterCriteria filter); Iterable<HistoricItem> 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 * @return a set of information about the persisted items
* {@link Item}.
*
* @return list of strings of item names contained in the store. Not null.
*/ */
Set<PersistenceItemInfo> getItemInfo(); Set<PersistenceItemInfo> getItemInfo();
} }