svn commit: r1304454 - in /ofbiz/trunk/applications/product: servicedef/services_maint.xml src/org/ofbiz/product/category/CategoryWorker.java

[jl...@apache.org]

Author: jleroux
Date: Fri Mar 23 15:42:24 2012
New Revision: 1304454

URL: http://svn.apache.org/viewvc?rev=1304454&view=rev
Log:
No functional change, only comments
Explains preferred way of using getCategoryTrail service and related method

Modified:
    ofbiz/trunk/applications/product/servicedef/services_maint.xml
    ofbiz/trunk/applications/product/src/org/ofbiz/product/category/CategoryWorker.java

Modified: ofbiz/trunk/applications/product/servicedef/services_maint.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/servicedef/services_maint.xml?rev=1304454&r1=1304453&r2=1304454&view=diff
==============================================================================
--- ofbiz/trunk/applications/product/servicedef/services_maint.xml (original)
+++ ofbiz/trunk/applications/product/servicedef/services_maint.xml Fri Mar 23 15:42:24 2012
@@ -120,7 +120,11 @@ under the License.
         <description> Returns a complete category trail - can be used for exporting proper category trees. 
         This is mostly useful when used in combination with breadcrumbs,  for building a facetted index tree, 
         or to export a category tree for migration to another system.
-        Will create the tree from root point to categoryId. </description>
+        Will create the tree from root point to categoryId. 
+        
+        This service is not meant to be run on every request.
+        Its best use is to generate the trail every so often and store somewhere (a lucene/solr tree, entities, cache or so). 
+        </description>
         <attribute name="productCategoryId" type="String" mode="IN" optional="false"/>
         <attribute name="trail" type="java.util.List" mode="OUT" optional="true"/>
     </service>

Modified: ofbiz/trunk/applications/product/src/org/ofbiz/product/category/CategoryWorker.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/src/org/ofbiz/product/category/CategoryWorker.java?rev=1304454&r1=1304453&r2=1304454&view=diff
==============================================================================
--- ofbiz/trunk/applications/product/src/org/ofbiz/product/category/CategoryWorker.java (original)
+++ ofbiz/trunk/applications/product/src/org/ofbiz/product/category/CategoryWorker.java Fri Mar 23 15:42:24 2012
@@ -428,7 +428,11 @@ public class CategoryWorker {
      * Returns a complete category trail - can be used for exporting proper category trees. 
      * This is mostly useful when used in combination with bread-crumbs,  for building a 
      * faceted index tree, or to export a category tree for migration to another system.
-     * Will create the tree from root point to categoryId. 
+     * Will create the tree from root point to categoryId.
+     * 
+     * This method is not meant to be run on every request.
+     * Its best use is to generate the trail every so often and store somewhere 
+     * (a lucene/solr tree, entities, cache or so). 
      * 
      * @param  productCategoryId  id of category the trail should be generated for
      * @returns List organized trail from root point to categoryId.