Author: jleroux
Date: Mon Jun 12 17:20:36 2017
New Revision: 1798495
URL: http://svn.apache.org/viewvc?rev=1798495&view=rev
Log:
No functional change
Improves the documentation of few methods which return an EntityListIterator
Modified:
ofbiz/ofbiz-framework/trunk/applications/content/src/main/java/org/apache/ofbiz/content/content/ContentSearch.java
ofbiz/ofbiz-framework/trunk/applications/workeffort/src/main/java/org/apache/ofbiz/workeffort/workeffort/WorkEffortSearch.java
ofbiz/ofbiz-framework/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/datasource/GenericDAO.java
ofbiz/ofbiz-framework/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/datasource/GenericHelper.java
ofbiz/ofbiz-framework/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/datasource/GenericHelperDAO.java
Modified:
ofbiz/ofbiz-framework/trunk/applications/content/src/main/java/org/apache/ofbiz/content/content/ContentSearch.java
URL:
http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/trunk/applications/content/src/main/java/org/apache/ofbiz/content/content/ContentSearch.java?rev=1798495&r1=1798494&r2=1798495&view=diff
==============================================================================
---
ofbiz/ofbiz-framework/trunk/applications/content/src/main/java/org/apache/ofbiz/content/content/ContentSearch.java
(original)
+++
ofbiz/ofbiz-framework/trunk/applications/content/src/main/java/org/apache/ofbiz/content/content/ContentSearch.java
Mon Jun 12 17:20:36 2017
@@ -271,6 +271,11 @@ public class ContentSearch {
}
}
+ /**
+ *@return EntityListIterator representing the result of the query:
NOTE THAT THIS MUST BE CLOSED WHEN YOU ARE
+ * DONE WITH IT (preferably in a finally block),
+ * AND DON'T LEAVE IT OPEN TOO LONG BECAUSE IT WILL MAINTAIN A
DATABASE CONNECTION.
+ */
public EntityListIterator doQuery(Delegator delegator) {
// handle the now assembled or and and keyword fixed lists
this.finishKeywordConstraints();
Modified:
ofbiz/ofbiz-framework/trunk/applications/workeffort/src/main/java/org/apache/ofbiz/workeffort/workeffort/WorkEffortSearch.java
URL:
http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/trunk/applications/workeffort/src/main/java/org/apache/ofbiz/workeffort/workeffort/WorkEffortSearch.java?rev=1798495&r1=1798494&r2=1798495&view=diff
==============================================================================
---
ofbiz/ofbiz-framework/trunk/applications/workeffort/src/main/java/org/apache/ofbiz/workeffort/workeffort/WorkEffortSearch.java
(original)
+++
ofbiz/ofbiz-framework/trunk/applications/workeffort/src/main/java/org/apache/ofbiz/workeffort/workeffort/WorkEffortSearch.java
Mon Jun 12 17:20:36 2017
@@ -289,6 +289,11 @@ public class WorkEffortSearch {
}
}
+ /**
+ *@return EntityListIterator representing the result of the query:
NOTE THAT THIS MUST BE CLOSED WHEN YOU ARE
+ * DONE WITH IT (preferably in a finally block),
+ * AND DON'T LEAVE IT OPEN TOO LONG BECAUSE IT WILL MAINTAIN A
DATABASE CONNECTION.
+ */
public EntityListIterator doQuery(Delegator delegator) {
// handle the now assembled or and and keyword fixed lists
this.finishKeywordConstraints();
Modified:
ofbiz/ofbiz-framework/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/datasource/GenericDAO.java
URL:
http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/datasource/GenericDAO.java?rev=1798495&r1=1798494&r2=1798495&view=diff
==============================================================================
---
ofbiz/ofbiz-framework/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/datasource/GenericDAO.java
(original)
+++
ofbiz/ofbiz-framework/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/datasource/GenericDAO.java
Mon Jun 12 17:20:36 2017
@@ -620,7 +620,8 @@ public class GenericDAO {
*@param orderBy The fields of the named entity to order the query by;
optionally add a " ASC" for ascending or " DESC" for descending
*@param findOptions An instance of EntityFindOptions that specifies
advanced query options. See the EntityFindOptions JavaDoc for more details.
*@return EntityListIterator representing the result of the query: NOTE
THAT THIS MUST BE CLOSED WHEN YOU ARE
- * DONE WITH IT, AND DON'T LEAVE IT OPEN TOO LONG BEACUSE IT WILL
MAINTAIN A DATABASE CONNECTION.
+ * DONE WITH IT (preferably in a finally block),
+ * AND DON'T LEAVE IT OPEN TOO LONG BECAUSE IT WILL MAINTAIN A
DATABASE CONNECTION.
*/
public EntityListIterator selectListIteratorByCondition(Delegator
delegator, ModelEntity modelEntity, EntityCondition whereEntityCondition,
EntityCondition havingEntityCondition, Collection<String>
fieldsToSelect, List<String> orderBy, EntityFindOptions findOptions)
Modified:
ofbiz/ofbiz-framework/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/datasource/GenericHelper.java
URL:
http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/datasource/GenericHelper.java?rev=1798495&r1=1798494&r2=1798495&view=diff
==============================================================================
---
ofbiz/ofbiz-framework/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/datasource/GenericHelper.java
(original)
+++
ofbiz/ofbiz-framework/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/datasource/GenericHelper.java
Mon Jun 12 17:20:36 2017
@@ -88,7 +88,8 @@ public interface GenericHelper {
*@param orderBy The fields of the named entity to order the query by;
optionally add a " ASC" for ascending or " DESC" for descending
*@param findOptions An instance of EntityFindOptions that specifies
advanced query options. See the EntityFindOptions JavaDoc for more details.
*@return EntityListIterator representing the result of the query: NOTE
THAT THIS MUST BE CLOSED WHEN YOU ARE
- * DONE WITH IT, AND DON'T LEAVE IT OPEN TOO LONG BEACUSE IT WILL
MAINTAIN A DATABASE CONNECTION.
+ * DONE WITH IT (preferably in a finally block),
+ * AND DON'T LEAVE IT OPEN TOO LONG BECAUSE IT WILL MAINTAIN A
DATABASE CONNECTION.
*/
public EntityListIterator findListIteratorByCondition(Delegator delegator,
ModelEntity modelEntity, EntityCondition whereEntityCondition,
EntityCondition havingEntityCondition, Collection<String>
fieldsToSelect, List<String> orderBy, EntityFindOptions findOptions)
Modified:
ofbiz/ofbiz-framework/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/datasource/GenericHelperDAO.java
URL:
http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/datasource/GenericHelperDAO.java?rev=1798495&r1=1798494&r2=1798495&view=diff
==============================================================================
---
ofbiz/ofbiz-framework/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/datasource/GenericHelperDAO.java
(original)
+++
ofbiz/ofbiz-framework/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/datasource/GenericHelperDAO.java
Mon Jun 12 17:20:36 2017
@@ -132,7 +132,8 @@ public class GenericHelperDAO implements
*@param orderBy The fields of the named entity to order the query by;
optionally add a " ASC" for ascending or " DESC" for descending
*@param findOptions An instance of EntityFindOptions that specifies
advanced query options. See the EntityFindOptions JavaDoc for more details.
*@return EntityListIterator representing the result of the query: NOTE
THAT THIS MUST BE CLOSED WHEN YOU ARE
- * DONE WITH IT, AND DON'T LEAVE IT OPEN TOO LONG BEACUSE IT WILL
MAINTAIN A DATABASE CONNECTION.
+ * DONE WITH IT (preferably in a finally block),
+ * AND DON'T LEAVE IT OPEN TOO LONG BECAUSE IT WILL MAINTAIN A
DATABASE CONNECTION.
*/
public EntityListIterator findListIteratorByCondition(Delegator delegator,
ModelEntity modelEntity, EntityCondition whereEntityCondition,
EntityCondition havingEntityCondition, Collection<String>
fieldsToSelect, List<String> orderBy, EntityFindOptions findOptions)
