Document LightDao interface

[lgpl/argeo-commons.git] / server / runtime / org.argeo.server.core / src / main / java / org / argeo / server / dao / LightDaoSupport.java

diff --git a/server/runtime/org.argeo.server.core/src/main/java/org/argeo/server/dao/LightDaoSupport.java b/server/runtime/org.argeo.server.core/src/main/java/org/argeo/server/dao/LightDaoSupport.java
index 25bc2b35f73a3b66a0f42115da335e7a7aa9622d..2d71c9319cd4e9315389ef29f4f68656e770cac5 100644 (file)
--- a/server/runtime/org.argeo.server.core/src/main/java/org/argeo/server/dao/LightDaoSupport.java
+++ b/server/runtime/org.argeo.server.core/src/main/java/org/argeo/server/dao/LightDaoSupport.java
@@ -17,14 +17,20 @@ package org.argeo.server.dao;
 
 import java.util.List;
 
+/** Minimal generic DAO for easy to implements objects <-> storage mapping. */
 public interface LightDaoSupport {
+       /** Retrieve an object of a given type by its unique key. */
        public <T> T getByKey(Class<T> clss, Object key);
 
+       /** Retrieve an object of a given type by the value of one of its fields. */
        public <T> T getByField(Class<T> clss, String field, Object value);
 
+       /** List all objects, optionally filtering them (implementation dependent) */
        public <T> List<T> list(Class<T> clss, Object filter);
 
+       /** Lis all supported object types. */
        public List<Class<?>> getSupportedClasses();
 
+       /** Save or update an object */
        public void saveOrUpdate(Object key, Object value, Class<?> clss);
 }