You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2015/12/22 10:34:05 UTC
[2/4] isis-site git commit: ISIS-1243: fixing naming of the domain
service API and SPI docs, also fix to asciidoc template.
http://git-wip-us.apache.org/repos/asf/isis-site/blob/88a9bc5a/content/guides/rgsvc.html
----------------------------------------------------------------------
diff --git a/content/guides/rgsvc.html b/content/guides/rgsvc.html
index 344de4e..5e8c1b1 100644
--- a/content/guides/rgsvc.html
+++ b/content/guides/rgsvc.html
@@ -522,9 +522,9 @@ table.CodeRay td.code>pre{padding:0}
<h2 id="_rgsvc">1. Domain Services</h2>
<div class="sectionbody">
<div class="paragraph">
-<p>This guide documents Apache Isis' domain services, both those that act as an <a href="#_rgsvc-api">API</a>
+<p>This guide documents Apache Isis' domain services, both those that act as an <a href="#_rgsvc_api">API</a>
(implemented by the framework for your domain objects to call), and those domain services that act as an
-<a href="#_rgsvc-spi">SPI</a> (implemented by your domain application and which are called by the framework).</p>
+<a href="#_rgsvc_spi">SPI</a> (implemented by your domain application and which are called by the framework).</p>
</div>
<div class="sect2">
<h3 id="_other_guides">1.1. Other Guides</h3>
@@ -582,7 +582,7 @@ table.CodeRay td.code>pre{padding:0}
</div>
</div>
<div class="sect1">
-<h2 id="_rgsvc-api">2. Domain Services API</h2>
+<h2 id="_rgsvc_api">2. Domain Services API</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Apache Isis includes an extensive number of domain services for your domain objects to use; simply define the service as an annotated field and Apache Isis will inject the service into your object. These services' API are all defined in Apache Isis' applib (<code>o.a.i.core:isis-core-applib</code> module); this minimizes the coupling between your code and Apache Isis. It also allows you to easily mock out these services in your unit tests.</p>
@@ -595,7 +595,7 @@ table.CodeRay td.code>pre{padding:0}
</td>
<td class="content">
<div class="paragraph">
-<p>In addition there are a number of domain services that constitute an SPI; if present they are used by Apache Isis itself rather than by your domain objects. A good example of this is the <a href="#_rgsvc-spi_AuditingService"><code>AuditingService3</code></a> service. The SPI services are covered in the <a href="#_rgsvc-spi">Domain Services (SPI) chapter</a>.</p>
+<p>In addition there are a number of domain services that constitute an SPI; if present they are used by Apache Isis itself rather than by your domain objects. A good example of this is the <a href="#_rgsvc_spi_AuditingService"><code>AuditingService3</code></a> service. The SPI services are covered in the <a href="#_rgsvc_spi">Domain Services (SPI) chapter</a>.</p>
</div>
</td>
</tr>
@@ -622,7 +622,7 @@ table.CodeRay td.code>pre{padding:0}
</thead>
<tbody>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc-api_ActionInvocationContext"><code>o.a.i.applib.</code><br>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc_api_ActionInvocationContext"><code>o.a.i.applib.</code><br>
<code>services.actinv</code><br>
<code>ActionInvocation-</code><br>
<code>Context</code></a></p></td>
@@ -639,7 +639,7 @@ table.CodeRay td.code>pre{padding:0}
</div></div></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc-api_BackgroundService"><code>o.a.i.applib.</code><br>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc_api_BackgroundService"><code>o.a.i.applib.</code><br>
<code>services.background</code><br>
<code>BackgroundService</code></a></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
@@ -652,11 +652,11 @@ table.CodeRay td.code>pre{padding:0}
</div></div></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
<p>depends on:<br>
-<a href="#_rgsvc-spi_BackgroundCommandService"><code>BackgroundCommand-Service</code></a></p>
+<a href="#_rgsvc_spi_BackgroundCommandService"><code>BackgroundCommand-Service</code></a></p>
</div></div></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc-api_BookmarkService"><code>o.a.i.applib.</code><br>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc_api_BookmarkService"><code>o.a.i.applib.</code><br>
<code>services.bookmark</code><br>
<code>BookmarkService</code></a></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
@@ -677,7 +677,7 @@ table.CodeRay td.code>pre{padding:0}
</div></div></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc-api_ClockService"><code>o.a.i.applib.</code><br>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc_api_ClockService"><code>o.a.i.applib.</code><br>
<code>services.clock</code><br>
<code>ClockService</code></a></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
@@ -693,7 +693,7 @@ table.CodeRay td.code>pre{padding:0}
</div></div></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc-api_CommandContext"><code>o.a.i.applib.</code><br>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc_api_CommandContext"><code>o.a.i.applib.</code><br>
<code>services.command</code><br>
<code>CommandContext</code></a></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
@@ -707,11 +707,11 @@ table.CodeRay td.code>pre{padding:0}
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
<p>API is also a concrete class.<br>
depends on:<br>
-<a href="#_rgsvc-spi_CommandService"><code>CommandService</code></a> for persistent <code>Command</code>, else in-memory impl. used</p>
+<a href="#_rgsvc_spi_CommandService"><code>CommandService</code></a> for persistent <code>Command</code>, else in-memory impl. used</p>
</div></div></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc-api_DeepLinkService"><code>o.a.i.applib</code><br>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc_api_DeepLinkService"><code>o.a.i.applib</code><br>
<code>services.deeplink</code><br>
<code>DeepLinkService</code></a></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
@@ -727,7 +727,7 @@ depends on:<br>
</div></div></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc-api_DomainObjectContainer"><code>o.a.i.applib</code><br>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc_api_DomainObjectContainer"><code>o.a.i.applib</code><br>
<code>DomainObjectContainer</code></a></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
<p>Generic repository to search, create and delete objects. Also miscellaneous other functions, eg obtain title of object.</p>
@@ -741,7 +741,7 @@ depends on:<br>
<td class="tableblock halign-left valign-top"><div></div></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc-api_EmailService"><code>o.a.i.applib.</code><br>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc_api_EmailService"><code>o.a.i.applib.</code><br>
<code>services.email</code><br>
<code>EmailService</code></a></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
@@ -755,7 +755,7 @@ depends on:<br>
<td class="tableblock halign-left valign-top"><div></div></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc-api_EventBusService"><code>o.a.i.applib.</code><br>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc_api_EventBusService"><code>o.a.i.applib.</code><br>
<code>services.eventbus</code><br>
<code>EventBusService</code></a></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
@@ -782,7 +782,7 @@ depends on:<br>
<td class="tableblock halign-left valign-top"><div></div></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc-api_FixtureScriptsDefault"><code>o.a.i.applib.</code><br>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc_api_FixtureScriptsDefault"><code>o.a.i.applib.</code><br>
<code>services.</code><br>
<code>fixturespec</code><br>
<code>FixtureScriptsDefault</code></a></p></td>
@@ -795,12 +795,12 @@ depends on:<br>
<code>isis-core-applib</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p>Interacts with <a href="#_rgsvc-spi_FixtureScriptsSpecificationProvider"><code>FixtureScripts-
+<p>Interacts with <a href="#_rgsvc_spi_FixtureScriptsSpecificationProvider"><code>FixtureScripts-
SpecificationProvider</code></a>.</p>
</div></div></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc-api_GuiceBeanProvider"><code>o.a.i.applib.</code><br>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc_api_GuiceBeanProvider"><code>o.a.i.applib.</code><br>
<code>services.guice</code><br>
<code>GuiceBeanProvider</code></a></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
@@ -814,7 +814,7 @@ SpecificationProvider</code></a>.</p>
<td class="tableblock halign-left valign-top"><div></div></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc-api_IsisJdoSupport"><code>o.a.i.applib.</code><br>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc_api_IsisJdoSupport"><code>o.a.i.applib.</code><br>
<code>services.jdosupport</code><br>
<code>IsisJdoSupport</code></a></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
@@ -828,7 +828,7 @@ SpecificationProvider</code></a>.</p>
<td class="tableblock halign-left valign-top"><div></div></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc-api_JaxbService"><code>o.a.i.applib.</code><br>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc_api_JaxbService"><code>o.a.i.applib.</code><br>
<code>services.jaxb</code><br>
<code>JaxbService</code></a></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
@@ -844,11 +844,11 @@ SpecificationProvider</code></a>.</p>
</div></div></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc-api_MementoService"><code>o.a.i.applib.</code><br>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc_api_MementoService"><code>o.a.i.applib.</code><br>
<code>services.memento</code><br>
<code>MementoService</code></a></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p>Capture a serializable memento of a set of primitives or <a href="#_rgsvc-api_BookmarkService">bookmarks</a>. Primarily used internally, eg in support of commands/auditing.</p>
+<p>Capture a serializable memento of a set of primitives or <a href="#_rgsvc_api_BookmarkService">bookmarks</a>. Primarily used internally, eg in support of commands/auditing.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
<p><code>MementoServiceDefault</code><br>
@@ -858,7 +858,7 @@ SpecificationProvider</code></a>.</p>
<td class="tableblock halign-left valign-top"><div></div></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc-api_MetaModelService"><code>o.a.i.applib.</code><br>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc_api_MetaModelService"><code>o.a.i.applib.</code><br>
<code>services.metamodel</code><br>
<code>MetaModelService</code></a></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
@@ -872,7 +872,7 @@ SpecificationProvider</code></a>.</p>
<td class="tableblock halign-left valign-top"><div></div></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc-api_QueryResultsCache"><code>o.a.i.applib.</code><br>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc_api_QueryResultsCache"><code>o.a.i.applib.</code><br>
<code>services.</code><br>
<code>queryresultscache</code><br>
<code>QueryResultsCache</code></a></p></td>
@@ -889,7 +889,7 @@ SpecificationProvider</code></a>.</p>
</div></div></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc-api_Scratchpad"><code>o.a.i.applib.</code><br>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc_api_Scratchpad"><code>o.a.i.applib.</code><br>
<code>services.scratchpad</code><br>
<code>Scratchpad</code></a></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
@@ -905,7 +905,7 @@ SpecificationProvider</code></a>.</p>
</div></div></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc-api_SudoService"><code>o.a.i.applib.</code><br>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc_api_SudoService"><code>o.a.i.applib.</code><br>
<code>services.sudo</code><br>
<code>SudoService</code></a></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
@@ -921,7 +921,7 @@ SpecificationProvider</code></a>.</p>
</div></div></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc-api_SwaggerService"><code>o.a.i.applib.</code><br>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc_api_SwaggerService"><code>o.a.i.applib.</code><br>
<code>services.sudo</code><br>
<code>SwaggerService</code></a></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
@@ -937,7 +937,7 @@ SpecificationProvider</code></a>.</p>
</div></div></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc-api_WrapperFactory"><code>o.a.i.applib.</code><br>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc_api_WrapperFactory"><code>o.a.i.applib.</code><br>
<code>services.wrapper</code><br>
<code>WrapperFactory</code></a></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
@@ -951,7 +951,7 @@ SpecificationProvider</code></a>.</p>
<td class="tableblock halign-left valign-top"><div></div></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc-api_XmlSnapshotService"><code>o.a.i.applib.</code><br>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_rgsvc_api_XmlSnapshotService"><code>o.a.i.applib.</code><br>
<code>services.xmlsnapshot</code><br>
<code>XmlSnapshotService</code></a></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
@@ -1012,7 +1012,7 @@ SpecificationProvider</code></a>.</p>
<code>isis-core-applib</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p>Replaced by <a href="#_rgsvc-api_ActionInvocationContext"><code>ActionInvocationContext</code></a></p>
+<p>Replaced by <a href="#_rgsvc_api_ActionInvocationContext"><code>ActionInvocationContext</code></a></p>
</div></div></td>
</tr>
</tbody>
@@ -1031,7 +1031,7 @@ SpecificationProvider</code></a>.</p>
</ul>
</div>
<div class="sect2">
-<h3 id="_rgsvc-api_ActionInvocationContext">2.1. <code>ActionInvocationContext</code></h3>
+<h3 id="_rgsvc_api_ActionInvocationContext">2.1. <code>ActionInvocationContext</code></h3>
<div class="paragraph">
<p>The <code>ActionInvocationContext</code> domain service is a <a href="rgant.html#_rgant-RequestScoped"><code>@RequestScoped</code></a> service intended to support the implementation of "bulk" actions annotated with <a href="rgant.html#_rgant-Action_invokeOn"><code>@Action#invokeOn()</code></a>. This allows the user to select multiple objects in a table and then invoke the same action against all of them.</p>
</div>
@@ -1084,7 +1084,7 @@ SpecificationProvider</code></a>.</p>
<p>For actions that are void or that return null, Apache Isis will return to the list once executed. But for bulk actions that are non-void, Apache Isis will render the returned object/value from the last object invoked (and simply discards the object/value of all actions except the last).</p>
</div>
<div class="paragraph">
-<p>One idiom is for the domain objects to also use the <a href="#_rgsvc-api_Scratchpad"><code>Scratchpad</code></a> service to share information, for example to aggregate values. The <code>ActionInvocationContext#isLast()</code> method can then be used to determine if all the information has been gathered, and then do something with it (eg derive variance across a range of values, render a graph etc).</p>
+<p>One idiom is for the domain objects to also use the <a href="#_rgsvc_api_Scratchpad"><code>Scratchpad</code></a> service to share information, for example to aggregate values. The <code>ActionInvocationContext#isLast()</code> method can then be used to determine if all the information has been gathered, and then do something with it (eg derive variance across a range of values, render a graph etc).</p>
</div>
<div class="paragraph">
<p>More prosaically, the <code>ActoinInvocationContext</code> can be used to ensure that the action behaves appropriately depending on how it has been invoked (on a single object and/or a collection) whether it is called in bulk mode or regular mode. Here’s a snippet of code from the bulk action in the Isis addon example <a href="https://github.com/isisaddons/isis-app-todoapp/">todoapp</a> (not ASF):</p>
@@ -1158,18 +1158,18 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
</div>
</div>
<div class="sect2">
-<h3 id="_rgsvc-api_BackgroundService">2.2. <code>BackgroundService</code></h3>
+<h3 id="_rgsvc_api_BackgroundService">2.2. <code>BackgroundService</code></h3>
<div class="paragraph">
-<p>The <code>BackgroundService</code>, and the companion <a href="#_rgsvc-spi_BackgroundCommandService"><code>BackgroundCommandService</code></a> SPI service (used by Apache Isis itself), enable action invocations to be persisted such that they may be invoked in the background.</p>
+<p>The <code>BackgroundService</code>, and the companion <a href="#_rgsvc_spi_BackgroundCommandService"><code>BackgroundCommandService</code></a> SPI service (used by Apache Isis itself), enable action invocations to be persisted such that they may be invoked in the background.</p>
</div>
<div class="paragraph">
<p>The <code>BackgroundService</code> is responsible for capturing a memento representing the action invocation in a typesafe way, and persisting it rather than executing it directly.</p>
</div>
<div class="paragraph">
-<p>The default <code>BackgroundServiceDefault</code> implementation (provided by isis-core) works by using a proxy wrapper around the target so that it can capture the action to invoke and its arguments using (a private copy of) <a href="#_rgsvc-api_MementoService"><code>MementoService</code></a>. The persistence delegates the persistence of the memento to an appropriate implementation of the companion <code>BackgroundCommandService</code>. One such implementation of <code>BackgroundCommandService</code> is provided by (non-ASF) <a href="http://github.com/isisaddons/isis-module-command">Isis addons' command</a> module.</p>
+<p>The default <code>BackgroundServiceDefault</code> implementation (provided by isis-core) works by using a proxy wrapper around the target so that it can capture the action to invoke and its arguments using (a private copy of) <a href="#_rgsvc_api_MementoService"><code>MementoService</code></a>. The persistence delegates the persistence of the memento to an appropriate implementation of the companion <code>BackgroundCommandService</code>. One such implementation of <code>BackgroundCommandService</code> is provided by (non-ASF) <a href="http://github.com/isisaddons/isis-module-command">Isis addons' command</a> module.</p>
</div>
<div class="paragraph">
-<p>The persisting of commands is only half the story; there needs to be a separate process to read the commands and execute them. The <code>BackgroundCommandExecution</code> abstract class (discussed <a href="#_rgsvc-api_BackgroundService_BackgroundCommandExecution">below</a>) provides infrastructure to do this; the concrete
+<p>The persisting of commands is only half the story; there needs to be a separate process to read the commands and execute them. The <code>BackgroundCommandExecution</code> abstract class (discussed <a href="#_rgsvc_api_BackgroundService_BackgroundCommandExecution">below</a>) provides infrastructure to do this; the concrete
implementation of this class depends on the configured <code>BackgroundCommandService</code> (in order to query for the persisted (background) <code>Command</code>s.</p>
</div>
<div class="sect3">
@@ -1240,7 +1240,7 @@ implementation of this class depends on the configured <code>BackgroundCommandSe
<p>One option is for the background jobs to take responsibility to notify the user themselves. In the above example, this would be the <code>submitInvoice()</code> method called upon each customer. One could imagine more complex designs where only the final command executed notifies the user.</p>
</div>
<div class="paragraph">
-<p>However, an alternative is to rely on the fact that the <code>BackgroundService</code> will automatically hint that the <code>Command</code> representing the original interaction (to <code>submitCustomerInvoices()</code> in the example above) should be persisted. This will be available if the related <a href="#_rgsvc-api_CommandContext"><code>CommandContext</code></a> and <a href="#_rgsvc-spi_CommandService"><code>CommandService</code></a> domain services are configured, and the <code>CommandService</code> supports persistent commands. Note that (non-ASF) <a href="http://github.com/isisaddons/isis-module-command">Isis addons' command</a> module does indeed provide such an implementation of <code>CommandService</code> (as well as of the required <code>BackgroundCommandService</code>).</p>
+<p>However, an alternative is to rely on the fact that the <code>BackgroundService</code> will automatically hint that the <code>Command</code> representing the original interaction (to <code>submitCustomerInvoices()</code> in the example above) should be persisted. This will be available if the related <a href="#_rgsvc_api_CommandContext"><code>CommandContext</code></a> and <a href="#_rgsvc_spi_CommandService"><code>CommandService</code></a> domain services are configured, and the <code>CommandService</code> supports persistent commands. Note that (non-ASF) <a href="http://github.com/isisaddons/isis-module-command">Isis addons' command</a> module does indeed provide such an implementation of <code>CommandService</code> (as well as of the required <code>BackgroundCommandService</code>).</p>
</div>
<div class="paragraph">
<p>Thus, the original action can run a query to obtain it corresponding <code>Command</code>, and return this to the user. The upshot is that the child <code>Command</code>s created by the <code>BackgroundService</code> will then be associated with <code>Command</code> for the original action.</p>
@@ -1264,7 +1264,7 @@ CommandContext commandContext; <i class="conum" data-value="1"></i><b>(1)</b></
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
-<td>the injected <a href="#_rgsvc-api_CommandContext"><code>CommandContext</code></a> domain service.</td>
+<td>the injected <a href="#_rgsvc_api_CommandContext"><code>CommandContext</code></a> domain service.</td>
</tr>
</table>
</div>
@@ -1289,17 +1289,17 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
<div class="sect3">
<h4 id="_related_services">2.2.5. Related Services</h4>
<div class="paragraph">
-<p>This service is closely related to the <a href="#_rgsvc-api_CommandContext"><code>CommandContext</code></a> and also that service’s supporting <a href="#_rgsvc-spi_CommandService"><code>CommandService</code></a> service.</p>
+<p>This service is closely related to the <a href="#_rgsvc_api_CommandContext"><code>CommandContext</code></a> and also that service’s supporting <a href="#_rgsvc_spi_CommandService"><code>CommandService</code></a> service.</p>
</div>
<div class="paragraph">
<p>The <code>CommandContext</code> service is responsible for providing a parent <code>Command</code> with which the background <code>Command</code>s can then be associated as children, while the <code>CommandService</code> is responsible for persisting those parent <code>Command`s. The latter is analogous to the way in which the `BackgroundCommandService</code> persists the child background `Command`s.</p>
</div>
<div class="paragraph">
-<p>The implementations of <code>CommandService</code> and <code>BackgroundCommandService</code> go together; typically both parent <code>Command`s and child background `Command`s will be persisted in the same way. The (non-ASF) <a href="http://github.com/isisaddons/isis-module-command">Isis addons' command</a> module provides implementations of both (see <a href="#_rgsvc-spi_CommandService">`CommandService</code></a> and <a href="#_rgsvc-spi_BackgroundCommandService"><code>BackgroundCommandService</code></a>).</p>
+<p>The implementations of <code>CommandService</code> and <code>BackgroundCommandService</code> go together; typically both parent <code>Command`s and child background `Command`s will be persisted in the same way. The (non-ASF) <a href="http://github.com/isisaddons/isis-module-command">Isis addons' command</a> module provides implementations of both (see <a href="#_rgsvc_spi_CommandService">`CommandService</code></a> and <a href="#_rgsvc_spi_BackgroundCommandService"><code>BackgroundCommandService</code></a>).</p>
</div>
</div>
<div class="sect3">
-<h4 id="_rgsvc-api_BackgroundService_BackgroundCommandExecution">2.2.6. <code>BackgroundCommandExecution</code> abstract class</h4>
+<h4 id="_rgsvc_api_BackgroundService_BackgroundCommandExecution">2.2.6. <code>BackgroundCommandExecution</code> abstract class</h4>
<div class="paragraph">
<p>The <code>BackgroundCommandExecution</code> (in isis-core) is an abstract template class provided by isis-core that defines an abstract hook method to obtain background `Command`s to be executed:</p>
</div>
@@ -1318,7 +1318,7 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
</div>
</div>
<div class="sect3">
-<h4 id="_rgsvc-api_BackgroundService_Quartz">2.2.7. Quartz Scheduler Configuration</h4>
+<h4 id="_rgsvc_api_BackgroundService_Quartz">2.2.7. Quartz Scheduler Configuration</h4>
<div class="paragraph">
<p>The last part of the puzzle is to actually run the (appropriate implementation of) `BackgroundCommandExecution). This could be run in a batch job overnight, or run continually by, say, the <a href="http://quartz-scheduler.org">Quartz</a> scheduler or by <a href="http://camel.apache.org" class="bare">http://camel.apache.org</a>]Apache Camel]. This section looks at configuring Quartz.</p>
</div>
@@ -1481,7 +1481,7 @@ org.quartz.plugin.jobInitializer.failOnFileNotFound = true</code></pre>
</div>
</div>
<div class="sect2">
-<h3 id="_rgsvc-api_BookmarkService">2.3. <code>BookmarkService</code></h3>
+<h3 id="_rgsvc_api_BookmarkService">2.3. <code>BookmarkService</code></h3>
<div class="paragraph">
<p>The <code>BookmarkService</code> provides the ability to obtain a serializable <code>o.a.i.applib.bookmarks.Bookmark</code> for any (persisted) domain object, and to lookup domain objects given a <code>Bookmark</code>. This can then in turn be converted to and from a string.</p>
</div>
@@ -1519,7 +1519,7 @@ org.quartz.plugin.jobInitializer.failOnFileNotFound = true</code></pre>
</table>
</div>
<div class="paragraph">
-<p><code>Bookmark</code>s are used by several other domain services as a means of storing areference to an arbitrary object (a polymorphic relationship). For example, the (non-ASF) <a href="http://github.com/isisaddons/isis-module-auditing">Isis addons' auditing</a> module’s implementation of <a href="#_rgsvc-spi_AuditingService"><code>AuditingService</code></a> uses bookmarks to capture the object that is being audited.</p>
+<p><code>Bookmark</code>s are used by several other domain services as a means of storing areference to an arbitrary object (a polymorphic relationship). For example, the (non-ASF) <a href="http://github.com/isisaddons/isis-module-auditing">Isis addons' auditing</a> module’s implementation of <a href="#_rgsvc_spi_AuditingService"><code>AuditingService</code></a> uses bookmarks to capture the object that is being audited.</p>
</div>
<div class="admonitionblock tip">
<table>
@@ -1615,10 +1615,10 @@ org.quartz.plugin.jobInitializer.failOnFileNotFound = true</code></pre>
<div class="sect3">
<h4 id="_usage_by_other_services">2.3.3. Usage by other services</h4>
<div class="paragraph">
-<p>Bookmarks are used by the (non-ASF) <a href="http://github.com/isisaddons/isis-module-command">Isis addons' command</a> module’s implementation of <a href="#_rgsvc-api_BackgroundCommandService"><code>BackgroundCommandService</code></a>, which uses a bookmark to capture the target object on which an action will be invoked subsequently.</p>
+<p>Bookmarks are used by the (non-ASF) <a href="http://github.com/isisaddons/isis-module-command">Isis addons' command</a> module’s implementation of <a href="#_rgsvc_api_BackgroundCommandService"><code>BackgroundCommandService</code></a>, which uses a bookmark to capture the target object on which an action will be invoked subsequently.</p>
</div>
<div class="paragraph">
-<p>Bookmarks are also used by the (non-ASF) <a href="http://github.com/isisaddons/isis-module-publishing">Isis addons' publishing</a> module’s implementation of <a href="#_rgsvc-spi_PublishingService"><code>PublishingService</code></a>, and by the (non-ASF) <a href="http://github.com/isisaddons/isis-module-auditing">Isis addons' auditing</a> module’s implementation of <a href="#_rgsvc-spi_AuditingService"><code>AuditingService</code></a>.</p>
+<p>Bookmarks are also used by the (non-ASF) <a href="http://github.com/isisaddons/isis-module-publishing">Isis addons' publishing</a> module’s implementation of <a href="#_rgsvc_spi_PublishingService"><code>PublishingService</code></a>, and by the (non-ASF) <a href="http://github.com/isisaddons/isis-module-auditing">Isis addons' auditing</a> module’s implementation of <a href="#_rgsvc_spi_AuditingService"><code>AuditingService</code></a>.</p>
</div>
</div>
<div class="sect3">
@@ -1637,7 +1637,7 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
</div>
</div>
<div class="sect2">
-<h3 id="_rgsvc-api_ClockService">2.4. <code>ClockService</code></h3>
+<h3 id="_rgsvc_api_ClockService">2.4. <code>ClockService</code></h3>
<div class="paragraph">
<p>Most applications deal with dates and times in one way or another. For example, if an <code>Order</code> is placed, then the <code>Customer</code> may have 30 days to pay the <code>Invoice</code>, otherwise a penalty may be levied.</p>
</div>
@@ -1765,13 +1765,13 @@ instead subclass from <code>o.a.i.applib.clock.Clock</code> singleton (as descri
</div>
</div>
<div class="sect2">
-<h3 id="_rgsvc-api_CommandContext">2.5. <code>CommandContext</code></h3>
+<h3 id="_rgsvc_api_CommandContext">2.5. <code>CommandContext</code></h3>
<div class="paragraph">
<p>The <code>CommandContext</code> service is a <a href="rgant.html#_rgant-RequestScoped">request-scoped</a> service that reifies the invocation of an action on a domain object into an object itself. This reified information is encapsulated within the <code>Command</code> object.</p>
</div>
<div class="paragraph">
<p>By default, the <code>Command</code> is held in-memory only; once the action invocation has completed, the <code>Command</code> object is gone. The optional
- supporting <a href="#_rgsvc-spi_CommandService"><code>CommandService</code></a> enables the implementation of <code>Command</code> to be pluggable. With an appropriate implementation (eg as provided by the (non-ASF) <a href="http://github.com/isisaddons/isis-module-command">Isis addons' command</a> module’s <a href="#_rgsvc-spi_CommandService"><code>CommandService</code></a>) the <code>Command</code> may then be persisted.</p>
+ supporting <a href="#_rgsvc_spi_CommandService"><code>CommandService</code></a> enables the implementation of <code>Command</code> to be pluggable. With an appropriate implementation (eg as provided by the (non-ASF) <a href="http://github.com/isisaddons/isis-module-command">Isis addons' command</a> module’s <a href="#_rgsvc_spi_CommandService"><code>CommandService</code></a>) the <code>Command</code> may then be persisted.</p>
</div>
<div class="paragraph">
<p>Persistent <code>Command</code>s support several use cases:</p>
@@ -1782,13 +1782,13 @@ instead subclass from <code>o.a.i.applib.clock.Clock</code> singleton (as descri
<p>they enable profiling of the running application (which actions are invoked then most often, what is their response time)</p>
</li>
<li>
-<p>they act as a parent to any background commands that might be invoked through the <a href="#_rgsvc-api_BackgroundService"><code>BackgroundService</code></a></p>
+<p>they act as a parent to any background commands that might be invoked through the <a href="#_rgsvc_api_BackgroundService"><code>BackgroundService</code></a></p>
</li>
<li>
-<p>if <a href="#_rgsvc-spi_AuditingService"><code>AuditingService</code></a> is configured, they provide better audit information, since the <code>Command</code> (the 'cause' of an action) can be correlated to the audit records (the "effect" of the action) through the unique <code>transactionId</code> GUID</p>
+<p>if <a href="#_rgsvc_spi_AuditingService"><code>AuditingService</code></a> is configured, they provide better audit information, since the <code>Command</code> (the 'cause' of an action) can be correlated to the audit records (the "effect" of the action) through the unique <code>transactionId</code> GUID</p>
</li>
<li>
-<p>if <a href="#_rgsvc-spi_PublishingService"><code>PublishingService</code></a> is configured, they provide better traceability as the <code>Command</code> is also correlated with any published events, again through the unique <code>transactionId</code> GUID</p>
+<p>if <a href="#_rgsvc_spi_PublishingService"><code>PublishingService</code></a> is configured, they provide better traceability as the <code>Command</code> is also correlated with any published events, again through the unique <code>transactionId</code> GUID</p>
</li>
</ul>
</div>
@@ -1796,7 +1796,7 @@ instead subclass from <code>o.a.i.applib.clock.Clock</code> singleton (as descri
<p>Assuming that the <code>CommandService</code> supports persistent <code>Command`s, the associated <a href="rgant.html#_rgant-Action_command"></code>@Action#command()<code></a> annotation also allows action invocations to be performed in the background. In this case the act of invoking the action on an object instead returns the `Command</code> to the user.</p>
</div>
<div class="sect3">
-<h4 id="_rgsvc-api_CommandContext_screencast">2.5.1. Screencast</h4>
+<h4 id="_rgsvc_api_CommandContext_screencast">2.5.1. Screencast</h4>
<div class="paragraph">
<p>The screencast provides a run-through of the command (profiling) service, auditing service, publishing service. It also shows how commands can be run in the background either explicitly by scheduling through the background service or implicitly by way of a framework annotation.</p>
</div>
@@ -1992,7 +1992,7 @@ instead subclass from <code>o.a.i.applib.clock.Clock</code> singleton (as descri
<p>When a background command is invoked, the user is returned the command object itself (to provide a handle to the command being invoked).</p>
</div>
<div class="paragraph">
-<p>This requires that an implementation of <a href="#_rgsvc-spi_CommandService"><code>CommandService</code></a> that persists the commands (such as the (non-ASF) <a href="http://github.com/isisaddons/isis-module-command">Isis addons' command</a> module’s <code>CommandService</code>) is configured. It also requires that a scheduler is configured to execute the background commands, see <a href="#_rgsvc-spi_BackgroundCommandService"><code>BackgroundCommandService</code></a>).</p>
+<p>This requires that an implementation of <a href="#_rgsvc_spi_CommandService"><code>CommandService</code></a> that persists the commands (such as the (non-ASF) <a href="http://github.com/isisaddons/isis-module-command">Isis addons' command</a> module’s <code>CommandService</code>) is configured. It also requires that a scheduler is configured to execute the background commands, see <a href="#_rgsvc_spi_BackgroundCommandService"><code>BackgroundCommandService</code></a>).</p>
</div>
</div>
<div class="sect3">
@@ -2063,7 +2063,7 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
<div class="sect3">
<h4 id="_related_services_2">2.5.6. Related Services</h4>
<div class="paragraph">
-<p>As discussed above, the supporting <a href="#_rgsvc-spi_CommandService"><code>CommandService</code></a> enables <code>Command</code> objects to be persisted. Other related services are the <a href="#_rgsvc-api_BackgroundService"><code>BackgroundService</code></a> and <a href="#_rgsvc-spi_BackgroundCommandService"><code>BackgroundCommandService</code></a>). For <code>BackgroundService</code> captures commands for execution in the background, while the [BackgroundCommandService] persists such commands for execution.</p>
+<p>As discussed above, the supporting <a href="#_rgsvc_spi_CommandService"><code>CommandService</code></a> enables <code>Command</code> objects to be persisted. Other related services are the <a href="#_rgsvc_api_BackgroundService"><code>BackgroundService</code></a> and <a href="#_rgsvc_spi_BackgroundCommandService"><code>BackgroundCommandService</code></a>). For <code>BackgroundService</code> captures commands for execution in the background, while the [BackgroundCommandService] persists such commands for execution.</p>
</div>
<div class="paragraph">
<p>The implementations of <code>CommandService</code> and <code>BackgroundCommandService</code> are intended to go together, so that persistent parent `Command`s can be associated with their child background `Command`s.</p>
@@ -2071,7 +2071,7 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
</div>
</div>
<div class="sect2">
-<h3 id="_rgsvc-api_DeepLinkService">2.6. <code>DeepLinkService</code></h3>
+<h3 id="_rgsvc_api_DeepLinkService">2.6. <code>DeepLinkService</code></h3>
<div class="paragraph">
<p>The <code>DeepLinkService</code> provides the ability to obtain a <code>java.net.URI</code> that links to a representation of any (persisted) domain entity or
view model.</p>
@@ -2100,13 +2100,13 @@ view model.</p>
</table>
</div>
<div class="paragraph">
-<p>The <a href="ugvw.html">Wicket viewer</a> this provides an implementation for accessing the representation through this viewer. (For the <a href="ugvro.html">RestfulObjects viewer</a>, a URL can be constructed according to the <a href="http://www.restfulobjects.org">Restful Objects spec</a> in conjunction with a <code>Bookmark</code> obtained via the <a href="#_rgsvc-api_BookmarkService"><code>BookmarkService</code></a>).</p>
+<p>The <a href="ugvw.html">Wicket viewer</a> this provides an implementation for accessing the representation through this viewer. (For the <a href="ugvro.html">RestfulObjects viewer</a>, a URL can be constructed according to the <a href="http://www.restfulobjects.org">Restful Objects spec</a> in conjunction with a <code>Bookmark</code> obtained via the <a href="#_rgsvc_api_BookmarkService"><code>BookmarkService</code></a>).</p>
</div>
</div>
<div class="sect3">
<h4 id="_usage_within_the_framework">2.6.2. Usage within the framework</h4>
<div class="paragraph">
-<p>The <a href="#_rgsvc-spi_EmailNotificationService"><code>EmailNotificationService</code></a> uses this service in order to generate emails as part of <a href="ugvw.html#_ugvw_features_user-registration">user registration</a>.</p>
+<p>The <a href="#_rgsvc_spi_EmailNotificationService"><code>EmailNotificationService</code></a> uses this service in order to generate emails as part of <a href="ugvw.html#_ugvw_features_user-registration">user registration</a>.</p>
</div>
</div>
<div class="sect3">
@@ -2138,7 +2138,7 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
</div>
</div>
<div class="sect2">
-<h3 id="_rgsvc-api_DomainObjectContainer">2.7. <code>DomainObjectContainer</code></h3>
+<h3 id="_rgsvc_api_DomainObjectContainer">2.7. <code>DomainObjectContainer</code></h3>
<div class="paragraph">
<p>The <code>DomainObjectContainer</code> service provides a set of general purpose functionality for domain objects to call. Principal amongst these are a generic APIs for querying objects and creating and persisting objects. In addition, the service provides access to security context (the "current user"), allows information and warning messages to be raised, and various other miscellaneous functions.</p>
</div>
@@ -2163,7 +2163,7 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
<p>The sections below discuss the functions provided by the service, broken out into categories.</p>
</div>
<div class="sect3">
-<h4 id="_rgsvc-api_DomainObjectContainer_object-creation-api">2.7.1. Object Creation API</h4>
+<h4 id="_rgsvc_api_DomainObjectContainer_object-creation-api">2.7.1. Object Creation API</h4>
<div class="paragraph">
<p>The object creation APIs are used to instantiate new domain objects or view models.</p>
</div>
@@ -2210,7 +2210,7 @@ container.persist(cust);</code></pre>
</div>
<div class="paragraph">
<p>As an alternative to using <code>newTransientInstance(…​)</code> or <code>mixin(…​)</code>, you could also simply <code>new()</code> up the object.
-Doing this will not inject any domain services, but they can be injected manually using <a href="rg .html#_rgsvc-api_DomainObjectContainer_services-api">#injectServicesInto(…​)`</a>.</p>
+Doing this will not inject any domain services, but they can be injected manually using <a href="rg .html#_rgsvc_api_DomainObjectContainer_services-api">#injectServicesInto(…​)`</a>.</p>
</div>
<div class="admonitionblock note">
<table>
@@ -2232,12 +2232,12 @@ that has less coupling to Isis and is arguably easier to understand (has "less m
</div>
</div>
<div class="sect3">
-<h4 id="_rgsvc-api_DomainObjectContainer_generic-repository-api">2.7.2. Generic Repository API</h4>
+<h4 id="_rgsvc_api_DomainObjectContainer_generic-repository-api">2.7.2. Generic Repository API</h4>
<div class="paragraph">
<p>The repository API acts as an abstraction over the JDO/DataNucleus objectstore. You can use it during prototyping to write naive queries (find all rows, then filter using the Guava <code>Predicate</code> API, or you can use it to call JDO <a href="http://www.datanucleus.org/products/accessplatform_4_0/jdo/query.html#named">named queries</a> using JDOQL.</p>
</div>
<div class="paragraph">
-<p>As an alternative, you could also use <a href="http://www.datanucleus.org/products/accessplatform_4_0/jdo/jdoql_typesafe.html">JDO typesafe queries</a> through the <a href="#_rgsvc-api_IsisJdoSupport"><code>IsisJdoSupport</code></a> service.</p>
+<p>As an alternative, you could also use <a href="http://www.datanucleus.org/products/accessplatform_4_0/jdo/jdoql_typesafe.html">JDO typesafe queries</a> through the <a href="#_rgsvc_api_IsisJdoSupport"><code>IsisJdoSupport</code></a> service.</p>
</div>
<div class="listingblock">
<div class="content">
@@ -2369,7 +2369,7 @@ that has less coupling to Isis and is arguably easier to understand (has "less m
</td>
<td class="content">
<div class="paragraph">
-<p>It is also possible to query using DataNucleus' type-safe query API. For more details, see <a href="#_rgsvc-api_IsisJdoSupport"><code>IsisJdoSupport</code></a>.</p>
+<p>It is also possible to query using DataNucleus' type-safe query API. For more details, see <a href="#_rgsvc_api_IsisJdoSupport"><code>IsisJdoSupport</code></a>.</p>
</div>
</td>
</tr>
@@ -2377,9 +2377,9 @@ that has less coupling to Isis and is arguably easier to understand (has "less m
</div>
</div>
<div class="sect3">
-<h4 id="_rgsvc-api_DomainObjectContainer_object-persistence-api">2.7.3. Object Persistence API</h4>
+<h4 id="_rgsvc_api_DomainObjectContainer_object-persistence-api">2.7.3. Object Persistence API</h4>
<div class="paragraph">
-<p>The persistence API is used to persist newly created objects (as per <a href="#_rgsvc-api_DomainObjectContainer_object-creation-api"><code>#newTransientInstance(…​)</code></a>, above and to delete (remove) objects that are persistent.</p>
+<p>The persistence API is used to persist newly created objects (as per <a href="#_rgsvc_api_DomainObjectContainer_object-creation-api"><code>#newTransientInstance(…​)</code></a>, above and to delete (remove) objects that are persistent.</p>
</div>
<div class="paragraph">
<p>Note that there is no API for updating existing objects; the framework (or rather, JDO/DataNucleus) performs object dirty tracking and so any objects that are modified in the course of a request will be automatically updated).</p>
@@ -2455,11 +2455,11 @@ container.persistIfNotAlready(cust);</code></pre>
<p>You should be aware that by default Apache Isis queues up calls to <code>#persist()</code> and <code>#remove()</code>. These are then executed either when the request completes (and the transaction commits), or if the queue is flushed. This can be done either implicitly by the framework, or as the result of a direct call to <code>#flush()</code>.</p>
</div>
<div class="paragraph">
-<p>By default the framework itself will cause <code>#flush()</code> to be called whenever a query is executed by way of <code>#allMatches(Query)</code>, as documented <a href="#_rgsvc-api_DomainObjectContainer_generic-repository-api">above</a>. However, this behaviour can be disabled using the <a href="rgcfg.html#_rgcfg_configuring-core">configuration property</a> <code>isis.services.container.disableAutoFlush</code>.</p>
+<p>By default the framework itself will cause <code>#flush()</code> to be called whenever a query is executed by way of <code>#allMatches(Query)</code>, as documented <a href="#_rgsvc_api_DomainObjectContainer_generic-repository-api">above</a>. However, this behaviour can be disabled using the <a href="rgcfg.html#_rgcfg_configuring-core">configuration property</a> <code>isis.services.container.disableAutoFlush</code>.</p>
</div>
</div>
<div class="sect3">
-<h4 id="_rgsvc-api_DomainObjectContainer_messages-api">2.7.4. Messages API</h4>
+<h4 id="_rgsvc_api_DomainObjectContainer_messages-api">2.7.4. Messages API</h4>
<div class="paragraph">
<p>The <code>DomainObjectContainer</code> allows domain objects to raise information, warning or error messages. These messages can either be simple strings, or can be translated.</p>
</div>
@@ -2528,7 +2528,7 @@ container.persistIfNotAlready(cust);</code></pre>
</div>
</div>
<div class="sect3">
-<h4 id="_rgsvc-api_DomainObjectContainer_security-api">2.7.5. Security API</h4>
+<h4 id="_rgsvc_api_DomainObjectContainer_security-api">2.7.5. Security API</h4>
<div class="paragraph">
<p>The security API allows the domain object to obtain the identity of the user interacting with said object.</p>
</div>
@@ -2577,7 +2577,7 @@ container.persistIfNotAlready(cust);</code></pre>
</div>
</div>
<div class="sect3">
-<h4 id="_rgsvc-api_DomainObjectContainer_presentation-api">2.7.6. Presentation API</h4>
+<h4 id="_rgsvc_api_DomainObjectContainer_presentation-api">2.7.6. Presentation API</h4>
<div class="paragraph">
<p>A responsibility of every domain object is to return a title. This can be done declaratively using the <a href="rgant.html#_rgant-Title"><code>@Title</code></a> annotation on property/ies, or it can be done imperatively by writing a <a href="rgcms.html#_rgcms_methods_reserved_title"><code>title()</code></a> method.</p>
</div>
@@ -2585,7 +2585,7 @@ container.persistIfNotAlready(cust);</code></pre>
<p>It’s quite common for titles to be built up of the titles of other objects. If using building up the title using <code>@Title</code> then Apache Isis will automatically use the title of the objects referenced by the annotated properties. We also need programmatic access to these titles if going the imperative route.</p>
</div>
<div class="paragraph">
-<p>Similarly, it often makes sense if <a href="#_rgsvc-api_DomainObjectContainer_messages-api">raising messages</a> to use the title of an object in a message rather (than a some other property of the object), because this is how end-users will be used to identifying the object.</p>
+<p>Similarly, it often makes sense if <a href="#_rgsvc_api_DomainObjectContainer_messages-api">raising messages</a> to use the title of an object in a message rather (than a some other property of the object), because this is how end-users will be used to identifying the object.</p>
</div>
<div class="paragraph">
<p>The API defined by <code>DomainObjectContainer</code> is simply:</p>
@@ -2638,7 +2638,7 @@ container.persistIfNotAlready(cust);</code></pre>
</div>
</div>
<div class="sect3">
-<h4 id="_rgsvc-api_DomainObjectContainer_validation-api">2.7.7. Validation API</h4>
+<h4 id="_rgsvc_api_DomainObjectContainer_validation-api">2.7.7. Validation API</h4>
<div class="paragraph">
<p>The validation API allows a domain object to programmatically validate itself or any other domain object. Specifically, this means the validating the current state of all properties, as well as any object-level validation defined by <a href="rgcms.html#_rgcms_methods_reserved_validate"><code>validate()</code></a>.</p>
</div>
@@ -2664,7 +2664,7 @@ container.persistIfNotAlready(cust);</code></pre>
</div>
</div>
<div class="sect3">
-<h4 id="_rgsvc-api_DomainObjectContainer_properties-api">2.7.8. Properties API</h4>
+<h4 id="_rgsvc_api_DomainObjectContainer_properties-api">2.7.8. Properties API</h4>
<div class="paragraph">
<p>The properties API allows domain objects to read the configuration properties aggregated from the various <a href="rgcfg.html#_rgcfg_configuration-files">configuration files</a>.</p>
</div>
@@ -2733,7 +2733,7 @@ container.persistIfNotAlready(cust);</code></pre>
</div>
</div>
<div class="sect3">
-<h4 id="_rgsvc-api_DomainObjectContainer_services-api">2.7.9. Services API</h4>
+<h4 id="_rgsvc_api_DomainObjectContainer_services-api">2.7.9. Services API</h4>
<div class="paragraph">
<p>The services API allows your domain objects to programmatically inject services into arbitrary objects, as well as to look up services by type:</p>
</div>
@@ -2754,7 +2754,7 @@ container.persistIfNotAlready(cust);</code></pre>
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
-<td>injects services into domain object; used extensively internally by the framework (eg to inject to other services, or to entities, or integration test instances, or fixture scripts). Service injection is done automatically if objects are created using <code>#newTransientInstance()</code>, described <a href="#_rgsvc-api_DomainObjectContainer_object-creation-api">above</a></td>
+<td>injects services into domain object; used extensively internally by the framework (eg to inject to other services, or to entities, or integration test instances, or fixture scripts). Service injection is done automatically if objects are created using <code>#newTransientInstance()</code>, described <a href="#_rgsvc_api_DomainObjectContainer_object-creation-api">above</a></td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
@@ -2767,7 +2767,7 @@ container.persistIfNotAlready(cust);</code></pre>
</table>
</div>
<div class="paragraph">
-<p>The primary use case is to instantiate domain objects using a regular constructor ("new is the new new") rather than using the <a href="#_rgsvc-api_DomainObjectContainer_object-creation-api"><code>#newTransientInstance()</code></a> API, and then using the <code>#injectServicesInto(…​)</code> API to set up any dependencies.</p>
+<p>The primary use case is to instantiate domain objects using a regular constructor ("new is the new new") rather than using the <a href="#_rgsvc_api_DomainObjectContainer_object-creation-api"><code>#newTransientInstance()</code></a> API, and then using the <code>#injectServicesInto(…​)</code> API to set up any dependencies.</p>
</div>
<div class="paragraph">
<p>For example:</p>
@@ -2792,7 +2792,7 @@ implementation of <code>DomainObjectContainer</code> service is automatically re
</div>
</div>
<div class="sect2">
-<h3 id="_rgsvc-api_EmailService">2.8. <code>EmailService</code></h3>
+<h3 id="_rgsvc_api_EmailService">2.8. <code>EmailService</code></h3>
<div class="paragraph">
<p>The <code>EmailService</code> provides the ability to send HTML emails, with attachments, to one or more recipients.</p>
</div>
@@ -2927,12 +2927,12 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
<div class="sect3">
<h4 id="_related_services_3">2.8.5. Related Services</h4>
<div class="paragraph">
-<p>The email service is used by the <a href="#_rgsvc-spi_EmailNotificationService"><code>EmailNotificationService</code></a> which is, in turn, used by <a href="#_rgsvc-spi_UserRegistrationService"><code>UserRegistrationService</code></a>.</p>
+<p>The email service is used by the <a href="#_rgsvc_spi_EmailNotificationService"><code>EmailNotificationService</code></a> which is, in turn, used by <a href="#_rgsvc_spi_UserRegistrationService"><code>UserRegistrationService</code></a>.</p>
</div>
</div>
</div>
<div class="sect2">
-<h3 id="_rgsvc-api_EventBusService">2.9. <code>EventBusService</code></h3>
+<h3 id="_rgsvc_api_EventBusService">2.9. <code>EventBusService</code></h3>
<div class="paragraph">
<p>The <code>EventBusService</code> allows domain objects to emit events to subscribing domain services using an in-memory event bus.</p>
</div>
@@ -2968,7 +2968,7 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
<p>Two implementations are available, using either <a href="https://code.google.com/p/guava-libraries/">Guava</a>'s <a href="https://code.google.com/p/guava-libraries/wiki/EventBusExplained"><code>EventBus</code></a>, or alternatively using the <a href="http://www.axonframework.org/">AxonFramework</a>'s <a href="http://www.axonframework.org/docs/2.4/single.html#d5e1489">SimpleEventBus</a>. It is also possible to plug in a custom implementation.</p>
</div>
<div class="sect3">
-<h4 id="_rgsvc-api_EventBusService_api-and-implementation">2.9.1. API & Implementation</h4>
+<h4 id="_rgsvc_api_EventBusService_api-and-implementation">2.9.1. API & Implementation</h4>
<div class="paragraph">
<p>The API defined by <code>EventBusService</code> is:</p>
</div>
@@ -3007,7 +3007,7 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
<div class="sect3">
<h4 id="_registering_subscribers">2.9.2. Registering Subscribers</h4>
<div class="paragraph">
-<p>The <code>register()</code> method should be called in the <a href="rgant.html#_rgant-PostConstruct"><code>@PostConstruct</code></a> lifecycle method. It is valid and probably the least confusing to readers to also "unregister" in the <a href="rgant.html#_rgant-PreDestroy"><code>@PreDestroy</code></a> lifecycle method (though as noted <a href="#_rgsvc-api_EventBusService_api-and-implementation">above</a>, unregistering is actually a no-op).</p>
+<p>The <code>register()</code> method should be called in the <a href="rgant.html#_rgant-PostConstruct"><code>@PostConstruct</code></a> lifecycle method. It is valid and probably the least confusing to readers to also "unregister" in the <a href="rgant.html#_rgant-PreDestroy"><code>@PreDestroy</code></a> lifecycle method (though as noted <a href="#_rgsvc_api_EventBusService_api-and-implementation">above</a>, unregistering is actually a no-op).</p>
</div>
<div class="paragraph">
<p>For example:</p>
@@ -3140,7 +3140,7 @@ registration. As a convenience, (as of <code>1.11.0-SNAPSHOT</code>) it is also
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
-<td><code>LibraryMemberLeaveEvent</code> is a subclass of <code>o.a.i.applib.eventbus.ActionDomainEvent</code>. The topic of subclassing is discussed in more detail <a href="#_rgsvc-api_EventBusService_event-hierarchy">below</a>.</td>
+<td><code>LibraryMemberLeaveEvent</code> is a subclass of <code>o.a.i.applib.eventbus.ActionDomainEvent</code>. The topic of subclassing is discussed in more detail <a href="#_rgsvc_api_EventBusService_event-hierarchy">below</a>.</td>
</tr>
</table>
</div>
@@ -3168,7 +3168,7 @@ registration. As a convenience, (as of <code>1.11.0-SNAPSHOT</code>) it is also
</div>
</div>
<div class="sect3">
-<h4 id="_rgsvc-api_EventBusService_event-hierarchy">2.9.4. Event hierarchy</h4>
+<h4 id="_rgsvc_api_EventBusService_event-hierarchy">2.9.4. Event hierarchy</h4>
<div class="paragraph">
<p>By creating domain event subtypes we can be more semantically precise and in turn providesmore flexibility for subscribers: they can choose whether to be broadly applicable (by subscribing to a superclass) or to be tightly focussed (by subscribing to a subclass).</p>
</div>
@@ -3323,7 +3323,7 @@ public <span class="directive">static</span> <span class="type">class</span> <sp
<div class="sect3">
<h4 id="_using_code_wrapperfactory_code">2.9.6. Using <code>WrapperFactory</code></h4>
<div class="paragraph">
-<p>An alternative way to cause events to be posted is through the <a href="#_rgsvc-api_WrapperFactory"><code>WrapperFactory</code></a>. This is useful when you wish to enforce a (lack-of-) trust boundary between the caller and the callee.</p>
+<p>An alternative way to cause events to be posted is through the <a href="#_rgsvc_api_WrapperFactory"><code>WrapperFactory</code></a>. This is useful when you wish to enforce a (lack-of-) trust boundary between the caller and the callee.</p>
</div>
<div class="paragraph">
<p>For example, suppose that <code>Customer#placeOrder(…​)</code> emits a <code>PlaceOrderEvent</code>, which is subscribed to by a <code>ReserveStockSubscriber</code>. This subscriber in turn calls <code>StockManagementService#reserveStock(…​)</code>. Any business rules on <code>#reserveStock(…​)</code> should be enforced.</p>
@@ -3353,7 +3353,7 @@ public <span class="directive">static</span> <span class="type">class</span> <sp
<div class="sect3">
<h4 id="_implementation_spi">2.9.7. Implementation SPI</h4>
<div class="paragraph">
-<p>The implementation of <code>EventBusService</code> provided by Apache Isis will by default use <a href="https://code.google.com/p/guava-libraries/">Guava</a>'s <a href="https://code.google.com/p/guava-libraries/wiki/EventBusExplained"><code>EventBus</code></a> as the underlying in-memory event bus. Alternatively the <a href="http://www.axonframework.org/">AxonFramework</a>'s <a href="http://www.axonframework.org/docs/2.4/single.html#d5e1489">SimpleEventBus</a> can be used. Which is used is specified through configuration property (described <a href="#_rgsvc-api_EventBusService_Configuration">below</a>).</p>
+<p>The implementation of <code>EventBusService</code> provided by Apache Isis will by default use <a href="https://code.google.com/p/guava-libraries/">Guava</a>'s <a href="https://code.google.com/p/guava-libraries/wiki/EventBusExplained"><code>EventBus</code></a> as the underlying in-memory event bus. Alternatively the <a href="http://www.axonframework.org/">AxonFramework</a>'s <a href="http://www.axonframework.org/docs/2.4/single.html#d5e1489">SimpleEventBus</a> can be used. Which is used is specified through configuration property (described <a href="#_rgsvc_api_EventBusService_Configuration">below</a>).</p>
</div>
<div class="admonitionblock note">
<table>
@@ -3364,7 +3364,7 @@ public <span class="directive">static</span> <span class="type">class</span> <sp
<td class="content">
<div class="title">Guava vs Axon, which to use?</div>
<div class="paragraph">
-<p>Guava actually queues up events; they are not guaranteed to be dispatched immediately. This generally is not problem, but can be for cases where the subscriber may in turn want to post its own events (using <a href="#_rgsvc-api_WrapperFactory"><code>WrapperFactory</code></a>).</p>
+<p>Guava actually queues up events; they are not guaranteed to be dispatched immediately. This generally is not problem, but can be for cases where the subscriber may in turn want to post its own events (using <a href="#_rgsvc_api_WrapperFactory"><code>WrapperFactory</code></a>).</p>
</div>
<div class="paragraph">
<p>The Axon <code>SimpleEventBus</code>-based implementation on the other hand is fully synchronous; events are dispatched as soon as they are posted. This works well in all scenarios (that we have tested).</p>
@@ -3393,7 +3393,7 @@ public <span class="directive">static</span> <span class="type">class</span> <sp
</div>
</div>
<div class="sect3">
-<h4 id="_rgsvc-api_EventBusService_Configuration">2.9.8. Configuration</h4>
+<h4 id="_rgsvc_api_EventBusService_Configuration">2.9.8. Configuration</h4>
<div class="paragraph">
<p>The implementation of <code>EventBusService</code> provided by Apache Isis will by default use <a href="https://code.google.com/p/guava-libraries/">Guava</a>'s <a href="https://code.google.com/p/guava-libraries/wiki/EventBusExplained"><code>EventBus</code></a> as the underlying in-memory event bus. Alternatively the <a href="http://www.axonframework.org/">AxonFramework</a>'s <a href="http://www.axonframework.org/docs/2.4/single.html#d5e1489">SimpleEventBus</a> can be used.</p>
</div>
@@ -3453,12 +3453,12 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
<p>The <code>EventBusService</code> is intended for fine-grained publish/subscribe for object-to-object interactions within an Apache Isis domain object model. The event propagation is strictly in-memory, and there are no restrictions on the object acting as the event (it need not be serializable, for example).</p>
</div>
<div class="paragraph">
-<p>The <a href="#_rgsvc-spi_PublishingService"><code>PublishingService</code></a> meanwhile is intended for coarse-grained publish/subscribe for system-to-system interactions, from Apache Isis to some other system. Here the only events published are those that action invocations (for actions annotated with <a href="rgant.html#_rgant-Action_publishing"><code>@Action#publishing()</code></a>) and of changed objects (for objects annotated with <a href="rgant.html#_rgant-DomainObject_publishing"><code>@DomainObject#publishing()</code></a>).</p>
+<p>The <a href="#_rgsvc_spi_PublishingService"><code>PublishingService</code></a> meanwhile is intended for coarse-grained publish/subscribe for system-to-system interactions, from Apache Isis to some other system. Here the only events published are those that action invocations (for actions annotated with <a href="rgant.html#_rgant-Action_publishing"><code>@Action#publishing()</code></a>) and of changed objects (for objects annotated with <a href="rgant.html#_rgant-DomainObject_publishing"><code>@DomainObject#publishing()</code></a>).</p>
</div>
</div>
</div>
<div class="sect2">
-<h3 id="_rgsvc-api_FixtureScriptsDefault">2.10. <code>FixtureScriptsDefault</code></h3>
+<h3 id="_rgsvc_api_FixtureScriptsDefault">2.10. <code>FixtureScriptsDefault</code></h3>
<div class="paragraph">
<p>The <code>FixtureScriptsDefault</code> service provides the ability to execute <a href="ugtst.html#_ugtst_fixture-scripts_api-and-usage">fixture scripts</a> .</p>
</div>
@@ -3466,7 +3466,7 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
<p>The service extends from the <a href="rgcms.html#_rgcms_classes_super_FixtureScripts"><code>FixtureScripts</code></a>, and is only instantiated by the framework if there no custom implementation of <code>FixtureScripts</code> has been otherwise provided; in other words it is a fallback.</p>
</div>
<div class="paragraph">
-<p>If this service is instantiated (as a fallback) then it uses the <a href="#_rgsvc-spi_FixtureScriptsSpecificationProvider"><code>FixtureScriptsSpecificationProvider</code></a> to obtain a <code>FixtureScriptsSpecification</code>. This configures this service, telling it which package to search for <code>FixtureScript</code> classes, how to execute those classes, and hints that influence the UI.</p>
+<p>If this service is instantiated (as a fallback) then it uses the <a href="#_rgsvc_spi_FixtureScriptsSpecificationProvider"><code>FixtureScriptsSpecificationProvider</code></a> to obtain a <code>FixtureScriptsSpecification</code>. This configures this service, telling it which package to search for <code>FixtureScript</code> classes, how to execute those classes, and hints that influence the UI.</p>
</div>
<div class="admonitionblock tip">
<table>
@@ -3476,7 +3476,7 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
</td>
<td class="content">
<div class="paragraph">
-<p>We recommend using <a href="#_rgsvc-spi_FixtureScriptsSpecificationProvider"><code>FixtureScriptsSpecificationProvider</code></a> rather than subclassing <a href="rgcms.html#_rgcms_classes_super_FixtureScripts"><code>FixtureScripts</code></a>.</p>
+<p>We recommend using <a href="#_rgsvc_spi_FixtureScriptsSpecificationProvider"><code>FixtureScriptsSpecificationProvider</code></a> rather than subclassing <a href="rgcms.html#_rgcms_classes_super_FixtureScripts"><code>FixtureScripts</code></a>.</p>
</div>
</td>
</tr>
@@ -3517,17 +3517,17 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
<div class="sect3">
<h4 id="_related_services_5">2.10.3. Related Services</h4>
<div class="paragraph">
-<p>The service interacts with <a href="#_rgsvc-spi_FixtureScriptsSpecificationProvider"><code>FixtureScriptsSpecificationProvider</code></a>.</p>
+<p>The service interacts with <a href="#_rgsvc_spi_FixtureScriptsSpecificationProvider"><code>FixtureScriptsSpecificationProvider</code></a>.</p>
</div>
</div>
</div>
<div class="sect2">
-<h3 id="_rgsvc-api_GuiceBeanProvider">2.11. <code>GuiceBeanProvider</code></h3>
+<h3 id="_rgsvc_api_GuiceBeanProvider">2.11. <code>GuiceBeanProvider</code></h3>
<div class="paragraph">
<p>The <code>GuiceBeanProvider</code> domain service acts as a bridge between Apache Isis' <a href="ugvw.html">Wicket viewer</a> internal bootstrapping using <a href="https://github.com/google/guice">Google Guice</a>.</p>
</div>
<div class="paragraph">
-<p>This service operates at a very low-level, and you are unlikely to have a need for it. It is used internally by the framework, in the default implementation of the <a href="#_rgsvc-api_DeepLinkService"><code>DeepLinkService</code></a>.</p>
+<p>This service operates at a very low-level, and you are unlikely to have a need for it. It is used internally by the framework, in the default implementation of the <a href="#_rgsvc_api_DeepLinkService"><code>DeepLinkService</code></a>.</p>
</div>
<div class="admonitionblock note">
<table>
@@ -3625,15 +3625,15 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
</div>
</div>
<div class="sect2">
-<h3 id="_rgsvc-api_IsisJdoSupport">2.12. <code>IsisJdoSupport</code></h3>
+<h3 id="_rgsvc_api_IsisJdoSupport">2.12. <code>IsisJdoSupport</code></h3>
<div class="paragraph">
-<p>The <code>IsisJdoSupport</code> service provides a number of general purpose methods for working with the JDO/DataNucleus objectstore. In general these act at a lower-level of abstraction than the APIs normally used (specifically, those of <a href="#_rgsvc-api_DomainObjectContainer"><code>DomainObjectContainer</code></a>), but nevertheless deal with some of the most common use cases. For service also provides access to the underlying JDO <code>PersistenceManager</code> for full control.</p>
+<p>The <code>IsisJdoSupport</code> service provides a number of general purpose methods for working with the JDO/DataNucleus objectstore. In general these act at a lower-level of abstraction than the APIs normally used (specifically, those of <a href="#_rgsvc_api_DomainObjectContainer"><code>DomainObjectContainer</code></a>), but nevertheless deal with some of the most common use cases. For service also provides access to the underlying JDO <code>PersistenceManager</code> for full control.</p>
</div>
<div class="paragraph">
<p>The following sections discuss the functionality provided by the service, broken out into categories.</p>
</div>
<div class="sect3">
-<h4 id="_rgsvc-api_IsisJdoSupport_executing-sql">2.12.1. Executing SQL</h4>
+<h4 id="_rgsvc_api_IsisJdoSupport_executing-sql">2.12.1. Executing SQL</h4>
<div class="paragraph">
<p>You can use the <code>IsisJdoSupportService</code> to perform arbitrary SQL SELECTs or UPDATEs:</p>
</div>
@@ -3678,7 +3678,7 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
</td>
<td class="content">
<div class="paragraph">
-<p>As an alternative, consider using DataNucleus' <a href="http://www.datanucleus.org/products/accessplatform_4_0/jdo/jdoql_typesafe.html">type-safe JDO query API</a>, discussed <a href="#_rgsvc-api_IsisJdoSupport_type-safe-query-api">below</a>.</p>
+<p>As an alternative, consider using DataNucleus' <a href="http://www.datanucleus.org/products/accessplatform_4_0/jdo/jdoql_typesafe.html">type-safe JDO query API</a>, discussed <a href="#_rgsvc_api_IsisJdoSupport_type-safe-query-api">below</a>.</p>
</div>
</td>
</tr>
@@ -3686,7 +3686,7 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
</div>
</div>
<div class="sect3">
-<h4 id="_rgsvc-api_IsisJdoSupport_type-safe-jdoql-queries">2.12.2. Type-safe JDOQL Queries</h4>
+<h4 id="_rgsvc_api_IsisJdoSupport_type-safe-jdoql-queries">2.12.2. Type-safe JDOQL Queries</h4>
<div class="paragraph">
<p>DataNucleus provides an <a href="http://www.datanucleus.org/products/accessplatform_4_0/jdo/jdoql_typesafe.html">extension to JDO</a>, so that JDOQL queries can be built up and executed using a set of type-safe classes.</p>
</div>
@@ -3756,7 +3756,7 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
</td>
<td class="content">
<div class="paragraph">
-<p>You can find the full example of the JDOQL equivalent in the <a href="#_rgsvc-api_DomainObjectContainer_generic-repository-api"><code>DomainObjectContainer</code></a></p>
+<p>You can find the full example of the JDOQL equivalent in the <a href="#_rgsvc_api_DomainObjectContainer_generic-repository-api"><code>DomainObjectContainer</code></a></p>
</div>
</td>
</tr>
@@ -3781,9 +3781,9 @@ DataNucleus <a href="http://www.datanucleus.org/products/accessplatform_4_0/jdo/
</div>
</div>
<div class="sect3">
-<h4 id="_rgsvc-api_IsisJdoSupport_fixture-support">2.12.3. Fixture support</h4>
+<h4 id="_rgsvc_api_IsisJdoSupport_fixture-support">2.12.3. Fixture support</h4>
<div class="paragraph">
-<p>When writing <a href="ugtst.html#_ugtst_integ-test-support">integration tests</a> you’ll usually need to tear down some/all mutable transactional data before each test. One way to do that is to use the <code>executeUpdate(…​)</code> method described <a href="#_rgsvc-api_IsisJdoSupport_executing-sql">above</a>.</p>
+<p>When writing <a href="ugtst.html#_ugtst_integ-test-support">integration tests</a> you’ll usually need to tear down some/all mutable transactional data before each test. One way to do that is to use the <code>executeUpdate(…​)</code> method described <a href="#_rgsvc_api_IsisJdoSupport_executing-sql">above</a>.</p>
</div>
<div class="paragraph">
<p>Alternatively, the <code>deleteAll(…​)</code> method will let your test delete all instances of a class without resorting to SQL:</p>
@@ -3834,7 +3834,7 @@ is temporarily disabled while this method is performed.</p>
</div>
</div>
<div class="sect3">
-<h4 id="_rgsvc-api_IsisJdoSupport_reloading-entities">2.12.4. Reloading entities</h4>
+<h4 id="_rgsvc_api_IsisJdoSupport_reloading-entities">2.12.4. Reloading entities</h4>
<div class="paragraph">
<p>An <a href="http://www.datanucleus.org/products/datanucleus/jdo/orm/relationships.html">(intentional) limitation</a> of JDO/DataNucleus is that persisting a child entity (in a 1:n bidirectional relationship) does not cause the parent’s collection to be updated.</p>
</div>
@@ -3909,7 +3909,7 @@ refresh the parent.</p>
</div>
</div>
<div class="sect3">
-<h4 id="_rgsvc-api_IsisJdoSupport_jdo-persistencemanager">2.12.5. JDO <code>PersistenceManager</code></h4>
+<h4 id="_rgsvc_api_IsisJdoSupport_jdo-persistencemanager">2.12.5. JDO <code>PersistenceManager</code></h4>
<div class="paragraph">
<p>The functionality provided by <code>IsisJdoSupport</code> focus only on the most common use cases. If you require more flexibility than this, eg for dynamically constructed queries, then you can use the service to access the underlying JDO <code>PersistenceManager</code> API:</p>
</div>
@@ -3953,13 +3953,13 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
</div>
</div>
<div class="sect2">
-<h3 id="_rgsvc-api_JaxbService">2.13. <code>JaxbService</code> (<code>1.11.0-SNAPSHOT</code>)</h3>
+<h3 id="_rgsvc_api_JaxbService">2.13. <code>JaxbService</code> (<code>1.11.0-SNAPSHOT</code>)</h3>
<div class="paragraph">
<p>The <code>JaxbService</code> (<code>1.11.0-SNAPSHOT</code>) allows instances of JAXB-annotated classes to be marshalled to XML and
unmarshalled from XML back into domain objects.</p>
</div>
<div class="sect3">
-<h4 id="_rgsvc-api_JaxbService_api-and-implementation">2.13.1. API & Implementation</h4>
+<h4 id="_rgsvc_api_JaxbService_api-and-implementation">2.13.1. API & Implementation</h4>
<div class="paragraph">
<p>The API defined by <code>JaxbService</code> is:</p>
</div>
@@ -4033,12 +4033,12 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
</div>
</div>
<div class="sect2">
-<h3 id="_rgsvc-api_MementoService">2.14. <code>MementoService</code></h3>
+<h3 id="_rgsvc_api_MementoService">2.14. <code>MementoService</code></h3>
<div class="paragraph">
<p>The <code>MementoService</code> was originally introduced to simplify the implementation of <a href="ugbtb.html#_ugbtb_more-advanced_view-models">ViewModel</a>s which are required by the framework to return string representation of all of their backing state, moreover which is safe for use within a URL.</p>
</div>
<div class="paragraph">
-<p>However, it can also be used to create a memento of arbitrary objects. Indeed, it is used internally by the core implementation of <a href="#_rgsvc-api_BackgroundService"><code>BackgroundService</code></a> to capture the state of action invocations so that they can be executed by a background process.</p>
+<p>However, it can also be used to create a memento of arbitrary objects. Indeed, it is used internally by the core implementation of <a href="#_rgsvc_api_BackgroundService"><code>BackgroundService</code></a> to capture the state of action invocations so that they can be executed by a background process.</p>
</div>
<div class="sect3">
<h4 id="_api_implementation_9">2.14.1. API & Implementation</h4>
@@ -4204,7 +4204,7 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
<div class="sect3">
<h4 id="_related_services_6">2.14.3. Related Services</h4>
<div class="paragraph">
-<p>The memento service is used by the <a href="#_rgsvc-api_CommandContext"><code>CommandContext</code></a> service and also <a href="#_rgsvc-spi_BackgroundCommandService"><code>BackgroundCommandService</code></a>. These both use a memento to capture a representation of an action invocation.</p>
+<p>The memento service is used by the <a href="#_rgsvc_api_CommandContext"><code>CommandContext</code></a> service and also <a href="#_rgsvc_spi_BackgroundCommandService"><code>BackgroundCommandService</code></a>. These both use a memento to capture a representation of an action invocation.</p>
</div>
</div>
<div class="sect3">
@@ -4223,12 +4223,12 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
</div>
</div>
<div class="sect2">
-<h3 id="_rgsvc-api_MetamodelService">2.15. <code>MetamodelService</code></h3>
+<h3 id="_rgsvc_api_MetamodelService">2.15. <code>MetamodelService</code></h3>
<div class="paragraph">
<p>The <code>MetaModelService</code> provides access (albeit currently extremely limited) to aspects of Apache Isis' internal metamodel.</p>
</div>
<div class="paragraph">
-<p>Currently this is limited to looking up the object type (as specified in <a href="rgant.html#_rgant-DomainObject_objectType"><code>@DomainObject#objectType()</code></a> and equivalent mechanisms, and as used in <a href="#_rgsvc-api_BookmarkService"><code>Bookmark</code></a>s and elsewhere) from an object’s class, and vice versa. In the future we expect other aspects of the metamodel to also be formally surfaced through this API.</p>
+<p>Currently this is limited to looking up the object type (as specified in <a href="rgant.html#_rgant-DomainObject_objectType"><code>@DomainObject#objectType()</code></a> and equivalent mechanisms, and as used in <a href="#_rgsvc_api_BookmarkService"><code>Bookmark</code></a>s and elsewhere) from an object’s class, and vice versa. In the future we expect other aspects of the metamodel to also be formally surfaced through this API.</p>
</div>
<div class="sect3">
<h4 id="_api_implementation_10">2.15.1. API & Implementation</h4>
@@ -4274,7 +4274,7 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
</div>
</div>
<div class="sect2">
-<h3 id="_rgsvc-api_QueryResultsCache">2.16. <code>QueryResultsCache</code></h3>
+<h3 id="_rgsvc_api_QueryResultsCache">2.16. <code>QueryResultsCache</code></h3>
<div class="paragraph">
<p>The purpose of the <code>QueryResultsCache</code> is to improve response times to the user, by providing a short-term (<a href="../../more-advanced-topics/how-to-09-020-How-to-write-a-typical-domain-service.html">request-scoped</a>) cache of the value of some (safe or idempotent) method call. This will typically be as the result of running a query, but could be any expensive operation.</p>
</div>
@@ -4415,12 +4415,12 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
<div class="sect3">
<h4 id="_related_services_7">2.16.4. Related Services</h4>
<div class="paragraph">
-<p>The <a href="#_rgsvc-api_Scratchpad"><code>Scratchpad</code></a> service is also intended for actions that are called many times, allowing arbitrary information to be shared between them. Those methods could be called from some outer loop in domain code, or by the framework itself if the action invoked has the <a href="rgant.html#_rgant-Action_invokeOn"><code>@Action#invokeOn()</code></a> annotation attribute set to <code>OBJECT_AND_COLLECTION</code> or <code>COLLECTION_ONLY</code>.</p>
+<p>The <a href="#_rgsvc_api_Scratchpad"><code>Scratchpad</code></a> service is also intended for actions that are called many times, allowing arbitrary information to be shared between them. Those methods could be called from some outer loop in domain code, or by the framework itself if the action invoked has the <a href="rgant.html#_rgant-Action_invokeOn"><code>@Action#invokeOn()</code></a> annotation attribute set to <code>OBJECT_AND_COLLECTION</code> or <code>COLLECTION_ONLY</code>.</p>
</div>
</div>
</div>
<div class="sect2">
-<h3 id="_rgsvc-api_Scratchpad">2.17. <code>Scratchpad</code></h3>
+<h3 id="_rgsvc_api_Scratchpad">2.17. <code>Scratchpad</code></h3>
<div class="paragraph">
<p>The <code>Scratchpad</code> service is a <a href="../../more-advanced-topics/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>
</div>
@@ -4553,15 +4553,15 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
<div class="sect3">
<h4 id="_related_services_8">2.17.4. Related Services</h4>
<div class="paragraph">
-<p>The <a href="#_rgsvc-api_ActionInteractionContext"><code>ActionInteractionContext</code></a> service allows <a href="rgant.html#_rgant-Action_invokeOn">bulk actions</a> to co-ordinate with each other.</p>
+<p>The <a href="#_rgsvc_api_ActionInteractionContext"><code>ActionInteractionContext</code></a> service allows <a href="rgant.html#_rgant-Action_invokeOn">bulk actions</a> to co-ordinate with each other.</p>
</div>
<div class="paragraph">
-<p>The <a href="#_rgsvc-api_QueryResultsCache"><code>QueryResultsCache</code></a> is useful for caching the results of expensive method calls.</p>
+<p>The <a href="#_rgsvc_api_QueryResultsCache"><code>QueryResultsCache</code></a> is useful for caching the results of expensive method calls.</p>
</div>
</div>
</div>
<div class="sect2">
-<h3 id="_rgsvc-api_SudoService">2.18. <code>SudoService</code></h3>
+<h3 id="_rgsvc_api_SudoService">2.18. <code>SudoService</code></h3>
<div class="paragraph">
<p>The <code>SudoService</code> allows the current user reported by the <code>DomainObjectContainer</code> to be temporarily changed to some
other user. This is useful both for <a href="ugtst.html#_ugtst_integ-test-support">integration testing</a> (eg if testing a workflow system whereby objects are moved from one user to another) and while running <a href="ugtst.html#_ugtst_fixture-scripts">fixture scripts</a> (eg setting up objects that would normally require several users to have acted upon the objects).</p>
@@ -4630,7 +4630,7 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
</div>
</div>
<div class="sect2">
-<h3 id="_rgsvc-api_SwaggerService">2.19. <code>SwaggerService</code> (<code>1.11.0-SNAPSHOT</code>)</h3>
+<h3 id="_rgsvc_api_SwaggerService">2.19. <code>SwaggerService</code> (<code>1.11.0-SNAPSHOT</code>)</h3>
<div class="paragraph">
<p>The <code>SwaggerService</code> (<code>1.11.0-SNAPSHOT</code>) generates <a href="http://swagger.io/">Swagger</a> spec files to describe the public and/or private RESTful APIs exposed by the <a href="ugvro.html">RestfulObjects viewer</a>.</p>
</div>
@@ -4652,7 +4652,7 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
</table>
</div>
<div class="sect3">
-<h4 id="_rgsvc-api_SwaggerService_api-and-implementation">2.19.1. API & Implementation</h4>
+<h4 id="_rgsvc_api_SwaggerService_api-and-implementation">2.19.1. API & Implementation</h4>
<div class="paragraph">
<p>The API defined by <code>SwaggerService</code> is:</p>
</div>
@@ -4722,7 +4722,7 @@ implementation of <code>SwaggerService</code> service is automatically registere
</div>
</div>
<div class="sect2">
-<h3 id="_rgsvc-api_WrapperFactory">2.20. <code>WrapperFactory</code></h3>
+<h3 id="_rgsvc_api_WrapperFactory">2.20. <code>WrapperFactory</code></h3>
<div class="paragraph">
<p>The <code>WrapperFactory</code> provides the ability to enforce business rules for programmatic interactions between domain objects. If there is a (lack-of-) trust boundary between the caller and callee — eg if they reside in different modules — then the wrapper factory is a useful mechanism to ensure that any business constraints defined by te callee are honoured.</p>
</div>
@@ -4907,7 +4907,7 @@ implementation of <code>SwaggerService</code> service is automatically registere
</td>
<td class="content">
<div class="paragraph">
-<p>It ought to be possible to implement an <a href="#_rgsvc-spi_ExceptionRecognizer"><code>ExceptionRecognizer</code></a>s that would allow the above boilerplate to be removed. This recognizer service would recognize the <code>InteractionException</code> and convert to a suitable message.</p>
+<p>It ought to be possible to implement an <a href="#_rgsvc_spi_ExceptionRecognizer"><code>ExceptionRecognizer</code></a>s that would allow the above boilerplate to be removed. This recognizer service would recognize the <code>InteractionException</code> and convert to a suitable message.</p>
</div>
<div class="paragraph">
<p>At the time of writing Apache Isis does not provide an out-of-the-box implementation of such an <code>ExceptionRecognizer</code>; but it should be simple enough to write oneā¦</p>
@@ -4977,7 +4977,7 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
</div>
</div>
<div class="sect2">
-<h3 id="_rgsvc-api_XmlSnapshotService">2.21. <code>XmlSnapshotService</code></h3>
+<h3 id="_rgsvc_api_XmlSnapshotService">2.21. <code>XmlSnapshotService</code></h3>
<div class="paragraph">
<p>The <code>XmlSnapshotService</code> provides the capability to generate XML snapshots (and if required corresponding XSD schemas) based on graphs of domain objects.</p>
</div>
@@ -5217,13 +5217,13 @@ further in this <a href="ugfun.html#_ugfun_how-tos_replacing-default-service-imp
<div class="sect3">
<h4 id="_related_services_10">2.21.6. Related Services</h4>
<div class="paragraph">
-<p>The <a href="#_rgsvc-api_BookmarkService"><code>BookmarkService</code></a> provides a mechanism for obtaining a string representations of a single domain object.</p>
+<p>The <a href="#_rgsvc_api_BookmarkService"><code>BookmarkService</code></a> provides a mechanism for obtaining a string representations of a single domain object.</p>
</div>
<div class="paragraph">
-<p>The <a href="#_rgsvc-api_MementoService"><code>MementoService</code></a> also provides a mechanism for generating string representations of domain objects.</p>
+<p>The <a href="#_rgsvc_api_MementoService"><code>MementoService</code></a> also provides a mechanism for generating string representations of domain objects.</p>
</div>
<div class="paragraph">
-<p>The <a href="#_rgsvc-api_JaxbService"><code>JaxbService</code></a> (<code>1.11.0-SNAPSHOT</code>) is a simple wrapper around
+<p>The <a href="#_rgsvc_api_JaxbService"><code>JaxbService</code></a> (<code>1.11.0-SNAPSHOT</code>) is a simple wrapper around
standard JAXB functionality for generating both XMLs and XSDs from JAXB-annotated classes. Note that (as of
<code>1.11.0-SNAPSHOT</code>) there is built-in support for JAXB classes (ie annotated with
<a href="rgant.html#_rgant-XmlRootElement"><code>@XmlRootElement</code></a>) to be used as view models.</p>
@@ -5233,16 +5233,16 @@ standard JAXB functionality for generating both XMLs and XSDs from JAXB-annotate
</div>
</div>
<div class="sect1">
-<h2 id="_rgsvc-spi">3. Domain Services SPI</h2>
+<h2 id="_rgsvc_spi">3. Domain Services SPI</h2>
<div class="sectionbody">
<div class="paragraph">
-<p>Apache Isis includes an extensive number of domain services for your domain objects to use; these are listed in <a href="#_rgsvc-api">Reference: Domain Services (API)</a> chapter.</p>
+<p>Apache Isis includes an extensive number of domain services for your domain objects to use; these are listed in <a href="#_rgsvc_api">Reference: Domain Services (API)</a> chapter.</p>
</div>
<div class="paragraph">
-<p>There are other domain services that constitute not an API but an SPI; if present they are used by Apache Isis itself rather than by your domain objects. A good example of this is the <a href="#_rgsvc-spi_AuditingService"><code>AuditingService</code></a> service; if an implementation is present then Apache Isis will call that service in order to record audit log entries. If no implementation is available then Apache Isis will carry on regardless.</p>
+<p>There are other domain services that constitute not an API but an SPI; if present they are used by Apache Isis itself rather than by your domain objects. A good example of this is the <a href="#_rgsvc_spi_AuditingService"><code>AuditingService</code></a> service; if an implementation is present then Apache Isis will call that service in order
<TRUNCATED>