hazza/DSpace
1
0
Fork 0
mirror of https://github.com/DSpace/DSpace.git synced 2025-10-15 14:03:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DS-2058] Javadoc fixes.

Browse Source
This commit is contained in:
Mark H. Wood
2021-05-13 11:51:34 -04:00
parent b688bd0145
commit 1ca945b6c6
1 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
dspace-api/src/main/java/org/dspace/core/AbstractHibernateDAO.java
View File

@@ -147,9 +147,9 @@ public abstract class AbstractHibernateDAO<T> implements GenericDAO<T> {
* @param cacheable * @param cacheable
* Whether or not this query should be cacheable * Whether or not this query should be cacheable
* @param clazz * @param clazz
* The clazz for which this CriteriaQuery will be executed on * The class for which this CriteriaQuery will be executed on
* @param maxResults * @param maxResults
* The maxmimum amount of results that will be returned for this CriteriaQuery * The maximum amount of results that will be returned for this CriteriaQuery
* @param offset * @param offset
* The offset to be used for the CriteriaQuery * The offset to be used for the CriteriaQuery
* @return A list of distinct results as depicted by the CriteriaQuery and parameters * @return A list of distinct results as depicted by the CriteriaQuery and parameters
@@ -206,8 +206,9 @@ public abstract class AbstractHibernateDAO<T> implements GenericDAO<T> {
/** /**
* Retrieve a unique result from the query. If multiple results CAN be * Retrieve a unique result from the query. If multiple results CAN be
* retrieved an exception will be thrown, * retrieved an exception will be thrown, so only use when the criteria
* so only use when the criteria state uniqueness in the database. * state uniqueness in the database.
* @param context current DSpace session.
* @param criteriaQuery JPA criteria * @param criteriaQuery JPA criteria
* @param cacheable whether or not this query should be cacheable. * @param cacheable whether or not this query should be cacheable.
* @param clazz type of object that should match the query. * @param clazz type of object that should match the query.
@@ -235,8 +236,10 @@ public abstract class AbstractHibernateDAO<T> implements GenericDAO<T> {
/** /**
* Retrieve a single result from the query. Best used if you expect a * Retrieve a single result from the query. Best used if you expect a
* single result, but this isn't enforced on the database. * single result, but this isn't enforced on the database.
* @param context current DSpace session
* @param criteriaQuery JPA criteria * @param criteriaQuery JPA criteria
* @return a DAO specified by the criteria * @return a DAO specified by the criteria
* @throws java.sql.SQLException passed through.
*/ */
public T singleResult(Context context, CriteriaQuery criteriaQuery) throws SQLException { public T singleResult(Context context, CriteriaQuery criteriaQuery) throws SQLException {
Query query = this.getHibernateSession(context).createQuery(criteriaQuery); Query query = this.getHibernateSession(context).createQuery(criteriaQuery);
@@ -307,7 +310,7 @@ public abstract class AbstractHibernateDAO<T> implements GenericDAO<T> {
* @param criteriaQuery * @param criteriaQuery
* The CriteriaQuery for which this result will be retrieved * The CriteriaQuery for which this result will be retrieved
* @param criteriaBuilder * @param criteriaBuilder
* The CriteriaBuilder that accompagnies the CriteriaQuery * The CriteriaBuilder that accompanies the CriteriaQuery
* @param root * @param root
* The root that'll determine on which class object we need to calculate the result * The root that'll determine on which class object we need to calculate the result
* @return The amount of results that would be found by this CriteriaQuery as an integer value * @return The amount of results that would be found by this CriteriaQuery as an integer value