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 2017/09/25 08:34:06 UTC
[18/24] isis-site git commit: ISIS-1712 - updates docs,
replace references to isisaddons and catalog.incode.org with
platform.incode.org
http://git-wip-us.apache.org/repos/asf/isis-site/blob/e5dcb0be/content/guides/rgant/rgant.html
----------------------------------------------------------------------
diff --git a/content/guides/rgant/rgant.html b/content/guides/rgant/rgant.html
index 29a638c..2475b50 100644
--- a/content/guides/rgant/rgant.html
+++ b/content/guides/rgant/rgant.html
@@ -390,7 +390,8 @@ table.CodeRay td.code>pre{padding:0}
</div>
<table class="tableblock frame-all grid-all spread">
<caption class="title">
- Table 1. Core annotations for domain objects, services and members (as of 1.8.0)
+ Table 1. Core annotations for domain objects, services and members (as of
+ <code>1.8.0</code>)
</caption>
<colgroup>
<col style="width: 25%;">
@@ -2269,7 +2270,7 @@ table.CodeRay td.code>pre{padding:0}
<p>If an appropriate <code>CommandService</code> is configured (for example using (non-ASF) <a href="http://github.com/isisaddons/isis-module-command">Isis addons' command</a> module), then the <code>Command</code> itself is persisted.</p>
</div>
<div class="paragraph">
- <p>By default, actions are invoked in directly in the thread of the invocation. If there is an implementation of <code>BackgroundCommandService</code> (as the <a href="http://github.com/isisaddons/isis-module-command">Isis addons' command</a> module does provide), then this means in turn that the <code>BackgroundService</code> can be used by the domain object code to programmatically create background <code>Command</code>s.</p>
+ <p>By default, actions are invoked in directly in the thread of the invocation. If there is an implementation of <code>BackgroundCommandService</code> (as the (non-ASF) <a href="http://platform.incode.org" target="_blank">Incode Platform</a>'s command module does provide), then this means in turn that the <code>BackgroundService</code> can be used by the domain object code to programmatically create background <code>Command</code>s.</p>
</div>
<div class="admonitionblock note">
<table>
@@ -4592,7 +4593,7 @@ WrapperFactory wrapperFactory;</code></pre>
<p>Which view is selected by default, if multiple views are available.</p>
</div>
<div class="paragraph">
- <p>See (non-ASF) <a href="http://www.isisaddons.org">Isis Addons</a> for further views.</p>
+ <p>See the (non-ASF) <a href="http://platform.incode.org" target="_blank">Incode Platform</a> for further Wicket components providing views.</p>
</div>
</div></td>
</tr>
@@ -4781,7 +4782,7 @@ WrapperFactory wrapperFactory;</code></pre>
</ul>
</div>
<div class="paragraph">
- <p>The <a href="../ugvw/ugvw.html">Wicket viewer</a> allows additional views to be configured to render collections of objects; at the time of writing thesee include the (non-ASF) (non-ASF) <a href="http://www.isisaddons.org">Isis Addons</a>' (non-ASF) <a href="http://github.com/isisaddons/isis-wicket-excel">excel</a> view, the <a href="http://github.com/isisaddons/isis-wicket-fullcalendar2">fullcalendar2</a> view, and the <a href="http://github.com/isisaddons/isis-wicket-gmap3">gmap3</a> view. If the objects to be rendered have the correct "shape", then the appropriate view will be made available. For example, objects with a date can be rendered using <code>calendar</code>; objects with locations can be rendered using <code>map</code>.</p>
+ <p>The <a href="../ugvw/ugvw.html">Wicket viewer</a> allows additional views to be configured to render collections of objects; at the time of writing thesee include the excel, fullcalendar2 and gmap3 provided by the (non-ASF) <a href="http://platform.incode.org" target="_blank">Incode Platform</a>. If the objects to be rendered have the correct "shape", then the appropriate view will be made available. For example, objects with a date can be rendered using <code>calendar</code>; objects with locations can be rendered using <code>map</code>.</p>
</div>
<div class="paragraph">
<p>The <code>defaultView()</code> attribute is used to select which of these views should be used by default for a given collection.</p>
@@ -5590,7 +5591,7 @@ WrapperFactory wrapperFactory;</code></pre>
<li> <p>as the value of <code>Bookmark#getObjectType()</code> and in the <code>toString()</code> value of <code>Bookmark</code> (see <a href="../rgsvc/rgsvc.html#_rgsvc_integration-api_BookmarkService"><code>BookmarkService</code></a>)</p>
<div class="ulist">
<ul>
- <li> <p>and thus in the "table-of-two-halves" pattern, as per (non-ASF) <a href="http://github.com/isisaddons/isis-module-poly">Isis addons' poly</a> module</p> </li>
+ <li> <p>and thus in the "table-of-two-halves" pattern, as per the (non-ASF) <a href="http://platform.incode.org" target="_blank">Incode Platform</a>'s poly module</p> </li>
</ul>
</div> </li>
<li> <p>in the serialization of <code>OidDto</code> in the <a href="../rgcms/rgcms.html#_rgcms_schema-cmd">command</a> and <a href="../rgcms/rgcms.html#_rgcms_schema-ixn">interaction</a> schemas</p> </li>
@@ -6897,7 +6898,7 @@ WrapperFactory wrapperFactory;</code></pre>
<li> <p>as the value of <code>Bookmark#getObjectType()</code> and in the <code>toString()</code> value of <code>Bookmark</code> (see <a href="../rgsvc/rgsvc.html#_rgsvc_integration-api_BookmarkService"><code>BookmarkService</code></a>)</p>
<div class="ulist">
<ul>
- <li> <p>and thus in the "table-of-two-halves" pattern, as per (non-ASF) <a href="http://github.com/isisaddons/isis-module-poly">Isis addons' poly</a> module</p> </li>
+ <li> <p>and thus in the "table-of-two-halves" pattern, as per the (non-ASF) <a href="http://platform.incode.org" target="_blank">Incode Platform</a>'s poly module</p> </li>
</ul>
</div> </li>
<li> <p>in the serialization of <code>OidDto</code> in the <a href="../rgcms/rgcms.html#_rgcms_schema-cmd">command</a> and <a href="../rgcms/rgcms.html#_rgcms_schema-ixn">interaction</a> schemas</p> </li>
@@ -8539,7 +8540,7 @@ WrapperFactory wrapperFactory;</code></pre>
</ul>
</div>
<div class="paragraph">
- <p>The actual class name of the domain service is only rendered for the <code>VIEW</code>, <code>VIEW_MENU_ONLY</code> and <code>VIEW_REST_ONLY</code> natures. Thus, you might also want to adopt naming conventions for your domain classes so you can infer the nature from the class. For example, the naming convention adopted (by and large) by the (non-ASF) <a href="http://www.isisaddons.org">Isis Addons</a> is <code>ProgrammaticServices</code> or <code>Repository</code> as a suffix for <code>DOMAIN</code> services, and <code>Contributions</code> as a suffix for <code>VIEW_CONTRIBUTIONS_ONLY</code> services.</p>
+ <p>The actual class name of the domain service is only rendered for the <code>VIEW</code>, <code>VIEW_MENU_ONLY</code> and <code>VIEW_REST_ONLY</code> natures. Thus, you might also want to adopt naming conventions for your domain classes so you can infer the nature from the class. For example, the naming convention adopted (by and large) by the (non-ASF) <a href="http://platform.incode.org" target="_blank">Incode Platform</a> is <code>ProgrammaticServices</code> or <code>Repository</code> as a suffix for <code>DOMAIN</code> services, and <code>Contributions</code> as a suffix for <code>VIEW_CONTRIBUTIONS_ONLY</code> services.</p>
</div>
<div class="paragraph">
<p>For example:</p>
@@ -9005,23 +9006,18 @@ WrapperFactory wrapperFactory;</code></pre>
</table>
</div>
<div class="paragraph">
- <p>while another comes from the (non-ASF) <a href="http://github.com/isisaddons/isis-module-devutils">Isis addons' devutils</a> module:</p>
+ <p>while others come from services provided by Apache Isis itself, eg:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@DomainServiceLayout</span>(
- menuBar = <span class="predefined-type">MenuBar</span>.SECONDARY,
- named = <span class="string"><span class="delimiter">"</span><span class="content">Prototyping</span><span class="delimiter">"</span></span>, <i class="conum" data-value="1"></i><b>(1)</b>
- menuOrder = <span class="string"><span class="delimiter">"</span><span class="content">500.600</span><span class="delimiter">"</span></span> <i class="conum" data-value="2"></i><b>(2)</b>
+ named = <span class="string"><span class="delimiter">"</span><span class="content">Prototyping</span><span class="delimiter">"</span></span>, <i class="conum" data-value="1"></i><b>(1)</b>
+ menuBar = <span class="predefined-type">MenuBar</span>.SECONDARY,
+ menuOrder = <span class="string"><span class="delimiter">"</span><span class="content">500.500</span><span class="delimiter">"</span></span> <i class="conum" data-value="2"></i><b>(2)</b>
)
-<span class="directive">public</span> <span class="type">class</span> <span class="class">DeveloperUtilitiesServiceMenu</span> {
- <span class="annotation">@MemberOrder</span>( sequence = <span class="string"><span class="delimiter">"</span><span class="content">500.600.1</span><span class="delimiter">"</span></span> ) <i class="conum" data-value="3"></i><b>(3)</b>
- <span class="directive">public</span> <span class="predefined-type">Clob</span> downloadMetaModel() { ... }
- <span class="annotation">@MemberOrder</span>( sequence = <span class="string"><span class="delimiter">"</span><span class="content">500.600.2</span><span class="delimiter">"</span></span> )
- <span class="directive">public</span> <span class="predefined-type">Blob</span> downloadLayouts() { ... }
- <span class="annotation">@ActionLayout</span>(named = <span class="string"><span class="delimiter">"</span><span class="content">Rebuild Services Meta Model</span><span class="delimiter">"</span></span>)
- <span class="annotation">@MemberOrder</span>( sequence = <span class="string"><span class="delimiter">"</span><span class="content">500.600.3</span><span class="delimiter">"</span></span>)
- <span class="directive">public</span> <span class="type">void</span> refreshServices() { ... }
+<span class="directive">public</span> <span class="type">class</span> <span class="class">MetaModelServicesMenu</span> {
+ <span class="annotation">@MemberOrder</span>(sequence=<span class="string"><span class="delimiter">"</span><span class="content">500.500.1</span><span class="delimiter">"</span></span>) <i class="conum" data-value="3"></i><b>(3)</b>
+ <span class="directive">public</span> <span class="predefined-type">Clob</span> downloadMetaModel( ... ) { ... }
...
}</code></pre>
</div>
@@ -9334,7 +9330,7 @@ WrapperFactory wrapperFactory;</code></pre>
<td class="icon"> <i class="fa icon-note" title="Note"></i> </td>
<td class="content">
<div class="paragraph">
- <p>An alternative and almost equivalent design would be to publish an event using the <a href="../rgsvc/rgsvc.html#_rgsvc_core-domain-api_EventBusService"><code>EventBusService</code></a> and implement the domain services as subscribers to the event. This alternative design is used in the (non-ASF) <a href="http://github.com/isisaddons/isis-module-poly">Isis addons' poly</a> module, for example.</p>
+ <p>An alternative and almost equivalent design would be to publish an event using the <a href="../rgsvc/rgsvc.html#_rgsvc_core-domain-api_EventBusService"><code>EventBusService</code></a> and implement the domain services as subscribers to the event. This alternative design is used in the (non-ASF) <a href="http://platform.incode.org" target="_blank">Incode Platform</a>'s poly module, for example.</p>
</div> </td>
</tr>
</tbody>
@@ -9957,7 +9953,7 @@ container.persist(cust);</code></pre>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
- <td>the <code>@ParameterLayout(named=…)</code> attribute is required for Java 7; for Java 8 it can be omitted if the (non-ASF) <a href="http://github.com/isisaddons/isis-metamodel-paraname8">Isis addons' paraname8</a> metamodel extension is used.</td>
+ <td>the <code>@ParameterLayout(named=…)</code> attribute is required for Java 7; for Java 8 it can be omitted if the (non-ASF) <a href="http://platform.incode.org" target="_blank">Incode Platform</a>'s paraname8 metamodel extension is used.</td>
</tr>
</tbody>
</table>
@@ -10001,7 +9997,7 @@ container.persist(cust);</code></pre>
<tbody>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
- <td>the <code>@ParameterLayout(named=…)</code> attribute is required for Java 7; for Java 8 it can be omitted if the (non-ASF) <a href="http://github.com/isisaddons/isis-metamodel-paraname8">Isis addons' paraname8</a> metamodel extension is used.</td>
+ <td>the <code>@ParameterLayout(named=…)</code> attribute is required for Java 7; for Java 8 it can be omitted if the (non-ASF) <a href="http://platform.incode.org" target="_blank">Incode Platform</a>'s paraname8 metamodel extension is used.</td>
</tr>
</tbody>
</table>
@@ -10582,7 +10578,7 @@ container.persist(cust);</code></pre>
<p>The <code>named()</code> attribute (or the <a href="../rgant/rgant.html#_rgant-aaa_deprecated">deprecated <code>@Named</code></a> annotation) is therefore often required to specify the parameter name.</p>
</div>
<div class="paragraph">
- <p>As of Java 8, the Java reflection API has been extended. The (non-ASF) <a href="http://github.com/isisaddons/isis-metamodel-paraname8">Isis addons' paraname8</a> metamodel extension provides support for this. Note that your application must (obviously) be running on Java 8, and be compiled with the <code>-parameters</code> compile flag for javac.</p>
+ <p>As of Java 8, the Java reflection API has been extended. The (non-ASF) <a href="http://platform.incode.org" target="_blank">Incode Platform</a>'s paraname8 metamodel extension provides support for this. Note that your application must (obviously) be running on Java 8, and be compiled with the <code>-parameters</code> compile flag for javac.</p>
</div>
<div class="paragraph">
<p>By default the name is HTML escaped. To allow HTML markup, set the related <code>namedEscaped()</code> attribute to <code>false</code>.</p>
@@ -10754,7 +10750,7 @@ container.persist(cust);</code></pre>
<li> <p>as the value of <code>Bookmark#getObjectType()</code> and in the <code>toString()</code> value of <code>Bookmark</code> (see <a href="../rgsvc/rgsvc.html#_rgsvc_integration-api_BookmarkService"><code>BookmarkService</code></a>)</p>
<div class="ulist">
<ul>
- <li> <p>and thus in the "table-of-two-halves" pattern, as per (non-ASF) <a href="http://github.com/isisaddons/isis-module-poly">Isis addons' poly</a> module</p> </li>
+ <li> <p>and thus in the "table-of-two-halves" pattern, as per the (non-ASF) <a href="http://platform.incode.org" target="_blank">Incode Platform</a>'s poly module</p> </li>
</ul>
</div> </li>
<li> <p>in the serialization of <code>OidDto</code> in the <a href="../rgcms/rgcms.html#_rgcms_schema-cmd">command</a> and <a href="../rgcms/rgcms.html#_rgcms_schema-ixn">interaction</a> schemas</p> </li>