svn commit: r419734 - /incubator/ofbiz/trunk/applications/product/src/org/ofbiz/product/catalog/CatalogWorker.java

[sichen]

Author: sichen
Date: Thu Jul  6 15:50:49 2006
New Revision: 419734

URL: http://svn.apache.org/viewvc?rev=419734&view=rev
Log:
Added documentaiton about how CatalogWorker.getCurrentCatalogId works.

Modified:
    incubator/ofbiz/trunk/applications/product/src/org/ofbiz/product/catalog/CatalogWorker.java

Modified: incubator/ofbiz/trunk/applications/product/src/org/ofbiz/product/catalog/CatalogWorker.java
URL: http://svn.apache.org/viewvc/incubator/ofbiz/trunk/applications/product/src/org/ofbiz/product/catalog/CatalogWorker.java?rev=419734&r1=419733&r2=419734&view=diff
==============================================================================
--- incubator/ofbiz/trunk/applications/product/src/org/ofbiz/product/catalog/CatalogWorker.java (original)
+++ incubator/ofbiz/trunk/applications/product/src/org/ofbiz/product/catalog/CatalogWorker.java Thu Jul  6 15:50:49 2006
@@ -147,6 +147,12 @@
         return null;
     }
 
+    /**
+     * Retrieves the current prodCatalogId.  First it will attempt to find it from a special
+     * request parameter or session attribute named CURRENT_CATALOG_ID.  Failing that, it will
+     * get the first catalog from the database as specified in getCatalogIdsAvailable().  
+     * If this behavior is undesired, give the user a selectable list of catalogs.
+     */
     public static String getCurrentCatalogId(ServletRequest request) {
         HttpSession session = ((HttpServletRequest) request).getSession();
         Map requestParameters = UtilHttp.getParameterMap((HttpServletRequest) request);