You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by bu...@apache.org on 2014/02/06 11:05:33 UTC

svn commit: r896611 [2/2] - in /websites/staging/isis/trunk: cgi-bin/ content/ content/applib-guide/reference/ content/applib-guide/reference/recognized-annotations/ content/core/services/

Modified: websites/staging/isis/trunk/content/core/services/scratchpad.html
==============================================================================
--- websites/staging/isis/trunk/content/core/services/scratchpad.html (original)
+++ websites/staging/isis/trunk/content/core/services/scratchpad.html Thu Feb  6 10:05:32 2014
@@ -279,21 +279,27 @@
 
 <p>The Scratchpad service is a <a href="../../applib-guide/domain-services/how-to-09-020-How-to-write-a-typical-domain-service.html">request-scoped</a> service to allow objects to exchange information even if they do not directly call each other.</p>
 
+<h3>API &amp; Implementation</h3>
+
 <p>The API of <code>Scratchpad</code> service is:</p>
 
 <pre><code>@RequestScoped
 public class Scratchpad {
-
     public Object get(Object key) { ... }
-
     public void put(Object key, Object value) { ... }
-
     public void clear() { ... }
-
 }
 </code></pre>
 
-<p>... as you can see, it is just a wrapper around a <code>java.util.Map</code>.</p>
+<p>... as you can see, just a wrapper around a <code>java.util.Map</code>.</p>
+
+<p>In fact, this is a concrete class:</p>
+
+<ul>
+<li><code>org.apache.isis.applib.services.scratchpad.Scratchpad</code></li>
+</ul>
+
+<h3>Usage</h3>
 
 <p>The most common use-case is for <a href="../../applib-guide/reference/recognized-annotations/Bulk.html">Bulk</a> actions that <a href="../../applib-guide/how-tos/how-to-01-065-How-to-add-an-action-to-be-called-on-every-object-in-a-list.html">act upon multiple objects in a list</a>.  The (same) <code>Scratchpad</code> service is injected into each of these objects, and they can use pass information.</p>
 
@@ -354,6 +360,21 @@ public void injectScratchpad(Scratchpad 
 
 <p>If using the Wicket viewer, the <code>ToDoItemBulkUpdate</code> view model returned from the last action invoked will be displayed.  Thereafter this view model can be used to perform a bulk update of the "enlisted" items.</p>
 
+<h3>Registering the Service</h3>
+
+<p>Register like any other service in <code>isis.properties</code>:</p>
+
+<pre><code>isis.services=...,\
+              com.mycompany.myapp.isis.SomeAuditingService,\
+              ...
+</code></pre>
+
+<h3>Related Services</h3>
+
+<p>The <a href="./bulk-interaction.html">Bulk.Interaction</a> service allows <a href="../../applib-guide/reference/recognized-annotations/Bulk.html">@Bulk</a> actions to co-ordinate with each other.</p>
+
+<p>The <a href="./query-results-cache.html">QueryResultsCache</a> is useful for caching the results of expensive method calls.</p>
+
 
 
       </div>

Modified: websites/staging/isis/trunk/content/documentation.html
==============================================================================
--- websites/staging/isis/trunk/content/documentation.html (original)
+++ websites/staging/isis/trunk/content/documentation.html Thu Feb  6 10:05:32 2014
@@ -456,7 +456,7 @@
 <li><a href="./applib-guide/how-tos/how-to-01-062-How-to-decouple-dependencies-using-contributions.html">Decoupling dependencies using contributions</a></li>
 <li><a href="./applib-guide/how-tos/how-to-01-065-How-to-add-an-action-to-be-called-on-every-object-in-a-list.html">Bulk actions, acting upon lists</a></li>
 <li><a href="./applib-guide/how-tos/how-to-04-060-How-to-set-up-and-maintain-bidirectional-relationships.html">Bidirectional relationships</a></li>
-<li><a href="">View models</a></li>
+<li><a href="./applib-guide/reference/ViewModel.html">View models</a></li>
 </ul>
 
 <h3>Derived props/colls</h3>
@@ -557,28 +557,49 @@
 <div class="col-md-4"></li>
 </ul>
 
-<h3>Singleton services</h3>
+<p>bookmark/memento services:</p>
 
 <ul>
-<li><a href="./applib-guide/supporting-features/about.html">Clock, Fixtures, etc</a></li>
-<li><a href="core/services/auditing-service.html">Auditing Service</a></li>
 <li><a href="core/services/bookmark-service.html">Bookmark Service</a></li>
-<li><a href="core/services/developer-utilities-service.html">Developer Utilities Service</a></li>
-<li><a href="core/services/exception-recognizers.html">Exception Recognizers</a></li>
+<li><a href="core/services/memento-service.html">Memento Service</a> [1.4.0-SNAPSHOT, stub]</li>
+<li><a href="core/services/xmlsnapshot-service.html">XmlSnapshot Service</a></li>
+</ul>
+
+<p>profiling/background execution:</p>
+
+<ul>
+<li><a href="core/services/command-context.html">Command Context/Service</a> [1.4.0-SNAPSHOT, stub]</li>
+<li><a href="core/services/background-service.html">Background Service / Background Command Service</a> [1.4.0-SNAPSHOT, stub]
+SNAPSHOT, stub]</li>
+</ul>
+
+<p>publishing/auditing:</p>
+
+<ul>
+<li><a href="core/services/auditing-service.html">Auditing Service</a></li>
 <li><a href="core/services/publishing-service.html">Publishing Service</a></li>
-<li><a href="core/services/settings-services.html">Settings Services</a></li>
 </ul>
 
-<h3>Request-scoped services</h3>
+<p>performance tuning/co-ordination:</p>
 
 <ul>
-<li><a href="core/services/scratchpad.html">Scratchpad</a> [1.4.0-SNAPSHOT]</li>
 <li><a href="core/services/query-results-cache.html">QueryResultsCache</a> [1.4.0-SNAPSHOT, stub]</li>
-<li><a href="core/services/bulk-interaction.html">Bulk.Interaction</a> [1.4.0-SNAPSHOT, stub]
-</div>
-<div class="col-md-4"></li>
+<li><a href="core/services/scratchpad.html">Scratchpad</a> [1.4.0-SNAPSHOT]</li>
+<li><a href="core/services/bulk-interaction.html">Bulk.Interaction</a> [1.4.0-SNAPSHOT, stub]</li>
+</ul>
+
+<p>other:</p>
+
+<ul>
+<li><a href="core/services/settings-services.html">Settings Services</a></li>
+<li><a href="core/services/exception-recognizers.html">Exception Recognizers</a></li>
+<li><a href="./applib-guide/supporting-features/about.html">Clock, Fixtures, etc</a></li>
+<li><a href="core/services/developer-utilities-service.html">Developer Utilities Service</a></li>
 </ul>
 
+<p></div>
+<div class="col-md-4"></p>
+
 <h3>Supporting features</h3>
 
 <ul>