Author: sebawagner
Date: Sun Sep 30 08:06:14 2012
New Revision: 1391963
URL: http://svn.apache.org/viewvc?rev=1391963&view=rev
Log:
Add some javaDoc to OmDAO
Modified:
incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/data/OmDAO.java
Modified:
incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/data/OmDAO.java
URL:
http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/data/OmDAO.java?rev=1391963&r1=1391962&r2=1391963&view=diff
==============================================================================
---
incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/data/OmDAO.java
(original)
+++
incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/data/OmDAO.java
Sun Sep 30 08:06:14 2012
@@ -22,10 +22,53 @@ import java.util.List;
import org.apache.openmeetings.persistence.beans.OmEntity;
+/**
+ * General interface to perform CRUD operations on entities
+ *
+ * @author solomax, swagner
+ *
+ * @param <T>
+ */
public interface OmDAO<T extends OmEntity> {
- T get(long id);
- List<T> get(int start, int count);
- long count();
- void update(T entity, long userId);
- void delete(T entity, long userId);
+
+ /**
+ * Get an instance of an {@link T}
+ *
+ * @param id
+ * @return
+ */
+ public T get(long id);
+
+ /**
+ * Get a list of instances of {@link T}
+ *
+ * @param start
+ * @param count
+ * @return
+ */
+ public List<T> get(int start, int count);
+
+ /**
+ * Count the number of instances of {@link T}
+ *
+ * @return
+ */
+ public long count();
+
+ /**
+ * Update an instance of {@link T}
+ *
+ * @param entity
+ * @param userId
+ */
+ public void update(T entity, long userId);
+
+ /**
+ * Delete an instance of {@link T}
+ *
+ * @param entity
+ * @param userId
+ */
+ public void delete(T entity, long userId);
+
}
