You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lenya.apache.org by an...@apache.org on 2007/01/30 16:22:12 UTC

svn commit: r501418 - /lenya/trunk/src/modules-core/usecase/java/src/org/apache/lenya/cms/usecase/UsecaseInvoker.java

Author: andreas
Date: Tue Jan 30 07:22:11 2007
New Revision: 501418

URL: http://svn.apache.org/viewvc?view=rev&rev=501418
Log:
Added some javadocs for UsecaseInvoker

Modified:
    lenya/trunk/src/modules-core/usecase/java/src/org/apache/lenya/cms/usecase/UsecaseInvoker.java

Modified: lenya/trunk/src/modules-core/usecase/java/src/org/apache/lenya/cms/usecase/UsecaseInvoker.java
URL: http://svn.apache.org/viewvc/lenya/trunk/src/modules-core/usecase/java/src/org/apache/lenya/cms/usecase/UsecaseInvoker.java?view=diff&rev=501418&r1=501417&r2=501418
==============================================================================
--- lenya/trunk/src/modules-core/usecase/java/src/org/apache/lenya/cms/usecase/UsecaseInvoker.java (original)
+++ lenya/trunk/src/modules-core/usecase/java/src/org/apache/lenya/cms/usecase/UsecaseInvoker.java Tue Jan 30 07:22:11 2007
@@ -22,35 +22,35 @@
 
 /**
  * <p>
- * This service allows to invoke a usecase.A typical usage scenario is the
- * composition of usecases - you can invoke one or multiple "child" usecases
- * from another usecase.
+ * This service allows to invoke a usecase in a convenient way. A typical usage
+ * scenario is the composition of usecases - you can invoke one or multiple
+ * "child" usecases from another usecase.
  * </p>
  * <p>
  * Example:
  * </p>
  * 
  * <pre>
- *    UsecaseInvoker invoker = null;
- *    try {
- *        invoker = (UsecaseInvoker) this.manager.lookup(UsecaseInvoker.ROLE);
- *        Map params = new HashMap();
- *        params.put(..., ...);
- *        invoker.invoke(getSourceUrl(), childUsecaseName, params);
- *    
- *        if (invoker.getResult() != UsecaseInvoker.SUCCESS) {
- *            List messages = invoker.getErrorMessages();
- *            for (Iterator i = messages.iterator(); i.hasNext();) {
- *                UsecaseMessage message = (UsecaseMessage) i.next();
- *                addErrorMessage(message.getMessage(), message.getParameters());
- *            }
- *        }
- *    } finally {
- *        if (invoker == null) {
- *            this.manager.release(invoker);
- *        }
- *    }
- *    
+ *     UsecaseInvoker invoker = null;
+ *     try {
+ *         invoker = (UsecaseInvoker) this.manager.lookup(UsecaseInvoker.ROLE);
+ *         Map params = new HashMap();
+ *         params.put(..., ...);
+ *         invoker.invoke(getSourceUrl(), childUsecaseName, params);
+ *     
+ *         if (invoker.getResult() != UsecaseInvoker.SUCCESS) {
+ *             List messages = invoker.getErrorMessages();
+ *             for (Iterator i = messages.iterator(); i.hasNext();) {
+ *                 UsecaseMessage message = (UsecaseMessage) i.next();
+ *                 addErrorMessage(message.getMessage(), message.getParameters());
+ *             }
+ *         }
+ *     } finally {
+ *         if (invoker == null) {
+ *             this.manager.release(invoker);
+ *         }
+ *     }
+ *     
  * </pre>
  * 
  * @version $Id$



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@lenya.apache.org
For additional commands, e-mail: commits-help@lenya.apache.org