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 2005/05/27 15:30:37 UTC
svn commit: r178776 -
/lenya/docu/src/documentation/content/xdocs/1_4/reference/usecase-framework/abstractusecase.xml
Author: andreas
Date: Fri May 27 06:30:35 2005
New Revision: 178776
URL: http://svn.apache.org/viewcvs?rev=178776&view=rev
Log:
added information about exit usecases
Modified:
lenya/docu/src/documentation/content/xdocs/1_4/reference/usecase-framework/abstractusecase.xml
Modified: lenya/docu/src/documentation/content/xdocs/1_4/reference/usecase-framework/abstractusecase.xml
URL: http://svn.apache.org/viewcvs/lenya/docu/src/documentation/content/xdocs/1_4/reference/usecase-framework/abstractusecase.xml?rev=178776&r1=178775&r2=178776&view=diff
==============================================================================
--- lenya/docu/src/documentation/content/xdocs/1_4/reference/usecase-framework/abstractusecase.xml (original)
+++ lenya/docu/src/documentation/content/xdocs/1_4/reference/usecase-framework/abstractusecase.xml Fri May 27 06:30:35 2005
@@ -65,10 +65,23 @@
<br/>
</li>
+ <li>Element <code><parameter></code> (arbitrary number)
+ <ul>
+ <li>Attribute <code>name</code></li>
+ <li>Attribute <code>value</code></li>
+ </ul>
+ <br/>
+ <p>
+ An arbitrary number of initial parameters can be passed to the usecase.
+ </p>
+ <br/>
+ </li>
+
<li>Element <code><view></code> (optional)
<ul>
<li>Attribute <code>template</code> (required)</li>
<li>Attribute <code>menu = (true | false)</code> (optional)</li>
+ <li>Element <code><parameter name="..." value="..."/></code> (arbitrary number)</li>
</ul>
<br/>
<p>
@@ -79,6 +92,21 @@
</p>
<br/>
</li>
+
+ <li>Element <code><exit></code> (optional)
+ <ul>
+ <li>Attribute <code>usecase</code> (required)</li>
+ <li>Element <code><parameter name="..." value="..."/></code> (arbitrary number)</li>
+ </ul>
+ <br/>
+ <p>
+ This element declares the exit usecase. By default, a usecase exits on the
+ URL it was started from, without any request parameters. Using this method,
+ is is possible to specify a usecase that should be called after this usecase
+ has exited. Additional parameter elements can be supplied.
+ </p>
+ <br/>
+ </li>
</ul>
</section>
@@ -87,7 +115,8 @@
<title>Extending AbstractUsecase</title>
<p>
- The following methods of the <code>AbstractUsecase</code> class are meant to be overridden:
+ The following methods of the <code>AbstractUsecase</code> class are meant to be overridden
+ or invoked by subclasses:
</p>
<ul>
@@ -159,6 +188,15 @@
these objects are checked out immediately.
</p>
<br/>
+ </li>
+
+ <li>
+ <code>protected void setExitParameter(String name, String value)</code>
+ <p>
+ Call this method to set a parameter that should be added to the exit request.
+ For instance, imagine a usecase which edits a user's groups. The exit usecase
+ might be <em>userProfile</em>, with the additional parameter <em>userId</em>.
+ </p>
</li>
</ul>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@lenya.apache.org
For additional commands, e-mail: commits-help@lenya.apache.org