svn commit: r178450 - /lenya/trunk/src/java/org/apache/lenya/cms/usecase/AbstractUsecase.java

Author: andreas
Date: Wed May 25 08:02:49 2005
New Revision: 178450

URL: http://svn.apache.org/viewcvs?rev=178450&view=rev
Log:
[minor change] added some javadocs

Modified:
    lenya/trunk/src/java/org/apache/lenya/cms/usecase/AbstractUsecase.java

Modified: lenya/trunk/src/java/org/apache/lenya/cms/usecase/AbstractUsecase.java
URL: 
http://svn.apache.org/viewcvs/lenya/trunk/src/java/org/apache/lenya/cms/usecase/AbstractUsecase.java?rev=178450&r1=178449&r2=178450&view=diff
==============================================================================
--- lenya/trunk/src/java/org/apache/lenya/cms/usecase/AbstractUsecase.java 
(original)
+++ lenya/trunk/src/java/org/apache/lenya/cms/usecase/AbstractUsecase.java Wed 
May 25 08:02:49 2005
@@ -673,6 +673,13 @@
     private String exitUsecaseName = null;
     private Map exitUsecaseParameters = new HashMap();
 
+    /**
+     * Sets the exit usecase of this usecase, i.e. the usecase that should be 
entered when this
+     * usecase is finished.
+     * @param usecaseName The name of the exit usecase.
+     * @param parameters Parameters to pass to the usecase or 
<code>null</code> if no parameters
+     *            should be passed.
+     */
     protected void setExitUsecase(String usecaseName, Map parameters) {
         this.exitUsecaseName = usecaseName;
         if (parameters != null) {
@@ -680,17 +687,21 @@
         }
     }
 
+    /**
+     * Returns the query string to access the exit usecase of this usecase.
+     * @return A query string of the form
+     *         <code>?lenya.usecase=...&amp;param1=foo&amp;param2=bar</code>.
+     */
     protected String getExitUsecaseQueryString() {
         String queryString = "";
         if (this.exitUsecaseName != null) {
             queryString = "?lenya.usecase=" + this.exitUsecaseName;
-            for (Iterator i = this.exitUsecaseParameters.keySet().iterator(); 
i.hasNext(); ) {
+            for (Iterator i = this.exitUsecaseParameters.keySet().iterator(); 
i.hasNext();) {
                 String key = (String) i.next();
                 String value = (String) this.exitUsecaseParameters.get(key);
                 queryString += "&" + key + "=" + value;
             }
-        }
-        else {
+        } else {
             String exitUsecase = getParameterAsString("lenya.exitUsecase");
             if (exitUsecase != null && !"".equals(exitUsecase)) {
                 queryString = "?lenya.usecase=" + exitUsecase;