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 2018/01/04 13:50:04 UTC
[20/28] isis-site git commit: updates SNAPSHOT
http://git-wip-us.apache.org/repos/asf/isis-site/blob/8c263125/content/versions/SNAPSHOT/guides/rgcms/rgcms.html
----------------------------------------------------------------------
diff --git a/content/versions/SNAPSHOT/guides/rgcms/rgcms.html b/content/versions/SNAPSHOT/guides/rgcms/rgcms.html
index 580a7c1..0ccd5c0 100644
--- a/content/versions/SNAPSHOT/guides/rgcms/rgcms.html
+++ b/content/versions/SNAPSHOT/guides/rgcms/rgcms.html
@@ -2528,7 +2528,7 @@ table.CodeRay td.code>pre{padding:0}
<td class="icon"> <i class="fa icon-warning" title="Warning"></i> </td>
<td class="content">
<div class="paragraph">
- <p>(As of <code>1.8.0</code>) there are known limitations with this functionality. Invariants are enforced when an object is initially created and when it is edited, however invariants are currently <em>not</em> enforced if an action is invoked.</p>
+ <p>There are known limitations with this functionality. Invariants <em>are</em> enforced when an object is initially created and when it is edited, however invariants are currently <em>not</em> enforced if an action is invoked.</p>
</div> </td>
</tr>
</tbody>
@@ -3129,20 +3129,7 @@ table.CodeRay td.code>pre{padding:0}
<td class="icon"> <i class="fa icon-tip" title="Tip"></i> </td>
<td class="content">
<div class="paragraph">
- <p>As of <code>1.15.0</code>, the framework-provided <code>AppManifestAbstract</code> and <code>AppManifestAbstract.Builder</code> make it easy to write <code>AppManifest</code> that can be used both to bootstrap the application "proper", and to be tweaked for use within integration tests.</p>
- </div> </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="admonitionblock tip">
- <table>
- <tbody>
- <tr>
- <td class="icon"> <i class="fa icon-tip" title="Tip"></i> </td>
- <td class="content">
- <div class="paragraph">
- <p>As of <code>1.16.0-SNAPSHOT</code>, the framework-provided <code>AppManifestAbstract2</code> and <code>AppManifestAbstract2.Builder</code> makes it even easier to write an <code>AppManifest</code>, this time using an implementation of a <a href="#_rgcms_classes_Module"><code>Module</code></a>.</p>
+ <p>The framework-provided <code>AppManifestAbstract2</code> and <code>AppManifestAbstract2.Builder</code> makes it easy to write an <code>AppManifest</code>, defined by a set of <a href="#_rgcms_classes_Module"><code>Module</code></a> implementations. The app manifest can then be used both to bootstrap the application "proper", or for integration tests.</p>
</div> </td>
</tr>
</tbody>
@@ -3417,8 +3404,21 @@ table.CodeRay td.code>pre{padding:0}
</div>
<div class="sect4">
<h5 id="__rgcms_classes_AppManifest-bootstrapping_bootstrapping_AppManifestAbstract">AppManifestAbstract</h5>
+ <div class="admonitionblock important">
+ <table>
+ <tbody>
+ <tr>
+ <td class="icon"> <i class="fa icon-important" title="Important"></i> </td>
+ <td class="content">
+ <div class="paragraph">
+ <p>The framework-provided <code>AppManifestAbstract2</code> and <code>AppManifestAbstract2.Builder</code> supercede <code>AppManifestAbstract</code>, making it easy to write an <code>AppManifest</code> defined by a set of <a href="#_rgcms_classes_Module"><code>Module</code></a> implementations.</p>
+ </div> </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
<div class="paragraph">
- <p>(As of <code>1.15.0</code>), the <code>AppManifestAbstract</code> and its associated builder (<code>AppManifestAbstract.Builder</code>) make it easy to bootstrap the application both as a webapp and also as an integration test.</p>
+ <p>The <code>AppManifestAbstract</code> and its associated builder (<code>AppManifestAbstract.Builder</code>) make it easy to bootstrap the application both as a webapp and also as an integration test.</p>
</div>
<div class="paragraph">
<p>Rather than implement <code>AppManifest</code> interface directly, instead your application subclasses from <code>AppManifestAbstract</code>. This takes an instance of a <code>AppManifestAbstract.Builder</code> in its constructor; the builder is what allows for variation between environments.</p>
@@ -5022,7 +5022,7 @@ table.CodeRay td.code>pre{padding:0}
</div> </li>
<li> <p><code>o.a.i.applib.value.Markup</code></p>
<div class="paragraph">
- <p>(As of <code>1.15.1</code>), intended for use as a read-only property to display arbitrary HTML.</p>
+ <p>Intended for use as a read-only property to display arbitrary HTML.</p>
</div> </li>
<li> <p><code>o.a.i.applib.value.Clob</code></p>
<div class="paragraph">
@@ -5298,7 +5298,7 @@ table.CodeRay td.code>pre{padding:0}
</ul>
</div>
<div class="paragraph">
- <p>The <code>ObjectContracts</code> test (and, as of <code>1.16.0-SNAPSHOT</code>, its replacement <code>ObjectContracts2</code>) provides a series of methods to make it easy for your domain objects to:</p>
+ <p>The <code>ObjectContracts2</code> utility class provides a series of methods to make it easy for your domain objects to:</p>
</div>
<div class="ulist">
<ul>
@@ -5337,7 +5337,7 @@ table.CodeRay td.code>pre{padding:0}
<td class="icon"> <i class="fa icon-warning" title="Warning"></i> </td>
<td class="content">
<div class="paragraph">
- <p>Note that <code>ObjectContracts</code> makes heavy use of Java Reflection. While it’s great to get going quickly in prototyping, we recommend you use your IDE to code generate implementations of these methods for production code.</p>
+ <p>Note that <code>ObjectContracts2</code> makes heavy use of Java Reflection. While it’s great to get going quickly in prototyping, we recommend you use your IDE to code generate implementations of these methods for production code.</p>
</div>
<div class="paragraph">
<p>Moreover (and perhaps even more importantly) <code>ObjectContracts</code> implementation can cause DataNucleus to recursively rehydrate a larger number of associated entities (More detail below).</p>
@@ -5713,7 +5713,7 @@ table.CodeRay td.code>pre{padding:0}
<td class="icon"> <i class="fa icon-note" title="Note"></i> </td>
<td class="content">
<div class="paragraph">
- <p>Prior to <code>1.13.0</code>, this identifier was the GUID of the Isis transaction in which the object was created (hence the name). As of <code>1.13.0</code>, this identifier actually is for the request/interaction in which the object was created, so is actually now mis-named.</p>
+ <p>This identifier actually is for the request/interaction in which the object was created, so is actually now mis-named.</p>
</div> </td>
</tr>
</tbody>
@@ -6086,7 +6086,7 @@ table.CodeRay td.code>pre{padding:0}
</div>
</div>
<div class="sect4">
- <h5 id="__rgcms_classes_mixins_Object_openRestApi"><code>openRestApi()</code> (<code>1.16.0-SNAPSHOT</code>)</h5>
+ <h5 id="__rgcms_classes_mixins_Object_openRestApi"><code>openRestApi()</code></h5>
<div class="paragraph">
<p>The <code>Object_openRestApi</code> mixin provides an action to navigate to the URL of the <a href="../ugvro/ugvro.html">Restful Objects resource</a> corresponding to the domain object. It has the following signature:</p>
</div>
@@ -6284,10 +6284,10 @@ table.CodeRay td.code>pre{padding:0}
<p>The component classes, meanwhile, are broadly equivalent to the "layout" annotations (<a href="../rgant/rgant.html#_rgant-PropertyLayout"><code>@PropertyLayout</code></a>, <a href="../rgant/rgant.html#_rgant-CollectionLayout"><code>@CollectionLayout</code></a>, <a href="../rgant/rgant.html#_rgant-ActionLayout"><code>@ActionLayout</code></a> and <a href="../rgant/rgant.html#_rgant-DomainObjectLayout"><code>@DomainObjectLayout</code></a></p>
</div>
<div class="paragraph">
- <p>All of the classes in this package are JAXB-annotated, meaning that they can be serialized to/from XML (the <code>component</code> classes in the <code><a href="http://isis.apache.org/applib/layout/component" class="bare">http://isis.apache.org/applib/layout/component</a></code> XSD namespace, the bootstrap 3 grid classes in the <code><a href="http://isis.apache.org/applib/layout/grid/bootstrap3" class="bare">http://isis.apache.org/applib/layout/grid/bootstrap3</a></code> XSD namespace). This ability to serialize to/from XML is used by the <a href="../rgsvc/rgsvc.html#_rgsvc_presentation-layer-spi_GridLoaderService"><code>GridLoaderService</code></a>, the default implementation of which reads the grid layout for a domain class from a <code>.layout.xml</code> file on the classpath. It also allows the grid to be exposed through the REST API provided by the <a href="../ugvro/ugvro.html">Restful Objects viewer</a>, as either XML or (as of <code>1.16.0-SNAPSHOT</code>) JSON.
</p>
+ <p>All of the classes in this package are JAXB-annotated, meaning that they can be serialized to/from XML (the <code>component</code> classes in the <code><a href="http://isis.apache.org/applib/layout/component" class="bare">http://isis.apache.org/applib/layout/component</a></code> XSD namespace, the bootstrap 3 grid classes in the <code><a href="http://isis.apache.org/applib/layout/grid/bootstrap3" class="bare">http://isis.apache.org/applib/layout/grid/bootstrap3</a></code> XSD namespace). This ability to serialize to/from XML is used by the <a href="../rgsvc/rgsvc.html#_rgsvc_presentation-layer-spi_GridLoaderService"><code>GridLoaderService</code></a>, the default implementation of which reads the grid layout for a domain class from a <code>.layout.xml</code> file on the classpath. It also allows the grid to be exposed through the REST API provided by the <a href="../ugvro/ugvro.html">Restful Objects viewer</a>, as either XML or JSON.</p>
</div>
<div class="paragraph">
- <p>(Also as of <code>1.16.0-SNAPSHOT</code>), the various components (properties, collections, actions and domain object) also allow a link to be associated with each. These links are populated by the framework automatically when exposing the object layout grid through the REST API, pointing back to the standard Restful Objects resources. This design greatly assists in the implementation of generic REST clients.</p>
+ <p>The various components (properties, collections, actions and domain object) also allow a link to be associated with each. These links are populated by the framework automatically when exposing the object layout grid through the REST API, pointing back to the standard Restful Objects resources. This design greatly assists in the implementation of generic REST clients.</p>
</div>
<div class="sect3">
<h4 id="__rgcms_classes_layout_component">3.13.1. Component</h4>
@@ -6379,7 +6379,7 @@ table.CodeRay td.code>pre{padding:0}
</div>
</div>
<div class="sect3">
- <h4 id="__rgcms_classes_layout_link">3.13.3. Link (<code>1.16.0-SNAPSHOT</code>)</h4>
+ <h4 id="__rgcms_classes_layout_link">3.13.3. Link</h4>
<div class="paragraph">
<p>The link classes reside in the <code>org.apache.isis.applib.layout.links</code> package, and consist of just the <code>Link</code> class:</p>
</div>
@@ -6399,7 +6399,7 @@ table.CodeRay td.code>pre{padding:0}
<tbody>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
- <td>an "rel" (as defined by section 2.7.1.2 of the RO spec v1.0), identifying the nature of the link.</td>
+ <td>a "rel" (as defined by section 2.7.1.2 of the RO spec v1.0), identifying the nature of the link.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
@@ -6422,7 +6422,7 @@ table.CodeRay td.code>pre{padding:0}
</div>
</div>
<div class="sect2">
- <h3 id="_rgcms_classes_menubars">3.14. MenuBars Layout (<code>1.16.0-SNAPSHOT</code>)</h3>
+ <h3 id="_rgcms_classes_menubars">3.14. MenuBars Layout</h3>
<div class="btn-group" style="float: right; font-size: small; padding: 6px; margin-top: -55px; ">
<button type="button" class="btn btn-xs btn-default" onclick="window.location.href="https://github.com/apache/isis/edit/master/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_menubars.adoc""><i class="fa fa-pencil-square-o"></i> Edit</button>
<button type="button" class="btn btn-xs btn-default dropdown-toggle" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false"><span class="caret"></span><span class="sr-only">Toggle Dropdown</span></button>
@@ -6681,7 +6681,7 @@ table.CodeRay td.code>pre{padding:0}
</tr>
<tr>
<td><i class="conum" data-value="7"></i><b>7</b></td>
- <td>the target object (or objects) to be invoked. As of <code>1.13.0</code>, a bulk action will create multiple commands, each with only a single target, but a future version of the framework may also support a single bulk command against this multiple targets (ie all-or-nothing).</td>
+ <td>the target object (or objects) to be invoked. A bulk action will create multiple commands, each with only a single target. (A future version of the framework may also support a single bulk command against this multiple targets, ie all-or-nothing).</td>
</tr>
<tr>
<td><i class="conum" data-value="8"></i><b>8</b></td>
@@ -7275,174 +7275,22 @@ table.CodeRay td.code>pre{padding:0}
</ul>
</div>
<div class="paragraph">
- <p>The "aim" schema defines the serialized form (or memento) of an action invocation.</p>
- </div>
- <div class="admonitionblock warning">
- <table>
- <tbody>
- <tr>
- <td class="icon"> <i class="fa icon-warning" title="Warning"></i> </td>
- <td class="content">
- <div class="paragraph">
- <p>This schema has been removed in <code>1.13.0</code>, replaced with <a href="../rgcms/rgcms.html#_rgcms_schema-ixn">ixn.xsd</a> (for action invocations/property edits) and with <a href="../rgcms/rgcms.html#_rgcms_schema-cmd">cmd.xsd</a> (commands, ie the <em>intention</em> to invoke an action/edit a property).</p>
- </div>
- <div class="paragraph">
- <p>The remaining content on this page describes how <code>CommandContext</code> works up to v1.12.x. However, as of <code>1.13.0</code> the <code>CommandContext</code> uses its own <code>cmd.xsd</code> schema).</p>
- </div> </td>
- </tr>
- </tbody>
- </table>
+ <p>The "aim" schema previously defined the serialized form (or memento) of an action invocation.</p>
</div>
<div class="paragraph">
- <p>Action invocations are captured (in memory rather than in serialized form) when the end-user invokes the action "through" the UI, by way of the <a href="../rgsvc/rgsvc.html#_rgsvc_application-layer-api_CommandContext">CommandContext</a> service. Using the <code>ActionInvocationMementoDtoUtils</code> utility class, a service can instantiate <code>ActionInvocationMementoDto</code> which can then be serialized to/from using the same <code>ActionInvocationMementoDtoUtils</code> class.</p>
- </div>
- <div class="listingblock">
- <div class="content">
- <pre class="CodeRay highlight"><code data-lang="xml"><span class="preprocessor"><?xml version="1.0" encoding="UTF-8"?></span>
-<span class="tag"><xs:schema</span> <span class="attribute-name">targetNamespace</span>=<span class="string"><span class="delimiter">"</span><span class="content">http://isis.apache.org/schema/aim</span><span class="delimiter">"</span></span> <i class="conum" data-value="1"></i><b>(1)</b>
- <span class="attribute-name">elementFormDefault</span>=<span class="string"><span class="delimiter">"</span><span class="content">qualified</span><span class="delimiter">"</span></span>
- <span class="attribute-name">xmlns:xs</span>=<span class="string"><span class="delimiter">"</span><span class="content">http://www.w3.org/2001/XMLSchema</span><span class="delimiter">"</span></span>
- <span class="attribute-name">xmlns</span>=<span class="string"><span class="delimiter">"</span><span class="content">http://isis.apache.org/schema/aim</span><span class="delimiter">"</span></span>
- <span class="attribute-name">xmlns:common</span>=<span class="string"><span class="delimiter">"</span><span class="content">http://isis.apache.org/schema/common</span><span class="delimiter">"</span></span><span class="tag">></span>
-
- <span class="tag"><xs:import</span> <span class="attribute-name">namespace</span>=<span class="string"><span class="delimiter">"</span><span class="content">http://isis.apache.org/schema/common</span><span class="delimiter">"</span></span> <i class="conum" data-value="2"></i><b>(2)</b>
- <span class="attribute-name">schemaLocation</span>=<span class="string"><span class="delimiter">"</span><span class="content">http://isis.apache.org/schema/common/common-1.0.xsd</span><span class="delimiter">"</span></span><span class="tag">/></span>
-
- <span class="tag"><xs:element</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">actionInvocationMementoDto</span><span class="delimiter">"</span></span><span class="tag">></span> <i class="conum" data-value="3"></i><b>(3)</b>
- <span class="tag"><xs:complexType></span>
- <span class="tag"><xs:sequence></span>
- <span class="tag"><xs:element</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">metadata</span><span class="delimiter">"</span></span><span class="tag">></span>
- <span class="tag"><xs:complexType></span>
- <span class="tag"><xs:sequence></span>
- <span class="tag"><xs:element</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">transactionId</span><span class="delimiter">"</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">"</span><span class="content">xs:string</span><span class="delimiter">"</span></span><span class="tag">/></span> <i class="conum" data-value="4"></i><b>(4)</b>
- <span class="tag"><xs:element</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">sequence</span><span class="delimiter">"</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">"</span><span class="content">xs:int</span><span class="delimiter">"</span></span><span class="tag">/></span> <i class="conum" data-value="5"></i><b>(5)</b>
- <span class="tag"><xs:element</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">timestamp</span><span class="delimiter">"</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">"</span><span class="content">xs:dateTime</span><span class="delimiter">"</span></span><span class="tag">/></span> <i class="conum" data-value="6"></i><b>(6)</b>
- <span class="tag"><xs:element</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">target</span><span class="delimiter">"</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">"</span><span class="content">common:oidDto</span><span class="delimiter">"</span></span><span class="tag">/></span> <i class="conum" data-value="7"></i><b>(7)</b>
- <span class="tag"><xs:element</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">targetClass</span><span class="delimiter">"</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">"</span><span class="content">xs:string</span><span class="delimiter">"</span></span><span class="tag">/></span> <i class="conum" data-value="8"></i><b>(8)</b>
- <span class="tag"><xs:element</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">targetAction</span><span class="delimiter">"</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">"</span><span class="content">xs:string</span><span class="delimiter">"</span></span><span class="tag">/></span> <i class="conum" data-value="9"></i><b>(9)</b>
- <span class="tag"><xs:element</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">actionIdentifier</span><span class="delimiter">"</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">"</span><span class="content">xs:string</span><span class="delimiter">"</span></span><span class="tag">/></span> <i class="conum" data-value="10"></i><b>(10)</b>
- <span class="tag"><xs:element</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">user</span><span class="delimiter">"</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">"</span><span class="content">xs:string</span><span class="delimiter">"</span></span><span class="tag">/></span> <i class="conum" data-value="11"></i><b>(11)</b>
- <span class="tag"><xs:element</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">title</span><span class="delimiter">"</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">"</span><span class="content">xs:string</span><span class="delimiter">"</span></span><span class="tag">/></span> <i class="conum" data-value="12"></i><b>(12)</b>
- <span class="tag"></xs:sequence></span>
- <span class="tag"></xs:complexType></span>
- <span class="tag"></xs:element></span>
- <span class="tag"><xs:element</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">payload</span><span class="delimiter">"</span></span><span class="tag">></span>
- <span class="tag"><xs:complexType></span>
- <span class="tag"><xs:sequence></span>
- <span class="tag"><xs:element</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">parameters</span><span class="delimiter">"</span></span><span class="tag">></span> <i class="conum" data-value="13"></i><b>(13)</b>
- <span class="tag"><xs:complexType></span>
- <span class="tag"><xs:sequence</span> <span class="attribute-name">maxOccurs</span>=<span class="string"><span class="delimiter">"</span><span class="content">unbounded</span><span class="delimiter">"</span></span><span class="tag">></span>
- <span class="tag"><xs:element</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">param</span><span class="delimiter">"</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">"</span><span class="content">paramDto</span><span class="delimiter">"</span></span><span class="tag">/></span>
- <span class="tag"></xs:sequence></span>
- <span class="tag"><xs:attribute</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">num</span><span class="delimiter">"</span></span> <span class="attribute-name">use</span>=<span class="string"><span class="delimiter">"</span><span class="content">required</span><span class="delimiter">"</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">"</span><span class="content">xs:int</span><span class="delimiter">"</span></span><span class="tag">/></span>
- <span class="tag"></xs:complexType></span>
- <span class="tag"></xs:element></span>
- <span class="tag"><xs:element</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">return</span><span class="delimiter">"</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">"</span><span class="content">common:valueDto</span><span class="delimiter">"</span></span> <i class="conum" data-value="14"></i><b>(14)</b>
- <span class="attribute-name">minOccurs</span>=<span class="string"><span class="delimiter">"</span><span class="content">0</span><span class="delimiter">"</span></span> <span class="attribute-name">maxOccurs</span>=<span class="string"><span class="delimiter">"</span><span class="content">1</span><span class="delimiter">"</span></span><span class="tag">/></span>
- <span class="tag"></xs:sequence></span>
- <span class="tag"></xs:complexType></span>
- <span class="tag"></xs:element></span>
- <span class="tag"></xs:sequence></span>
- <span class="tag"></xs:complexType></span>
- <span class="tag"></xs:element></span>
-
- <span class="tag"><xs:complexType</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">paramDto</span><span class="delimiter">"</span></span><span class="tag">></span> <i class="conum" data-value="15"></i><b>(15)</b>
- <span class="tag"><xs:sequence></span>
- <span class="tag"><xs:element</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">value</span><span class="delimiter">"</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">"</span><span class="content">common:valueDto</span><span class="delimiter">"</span></span><span class="tag">/></span> <i class="conum" data-value="16"></i><b>(16)</b>
- <span class="tag"></xs:sequence></span>
- <span class="tag"><xs:attribute</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">parameterName</span><span class="delimiter">"</span></span> <span class="attribute-name">use</span>=<span class="string"><span class="delimiter">"</span><span class="content">required</span><span class="delimiter">"</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">"</span><span class="content">xs:string</span><span class="delimiter">"</span></span><span class="tag">/></span> <i class="conum" data-value="17"></i><b>(17)</b>
- <span class="tag"><xs:attribute</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">parameterType</span><span class="delimiter">"</span></span> <span class="attribute-name">use</span>=<span class="string"><span class="delimiter">"</span><span class="content">required</span><span class="delimiter">"</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">"</span><span class="content">common:valueType</span><span class="delimiter">"</span></span><span class="tag">/></span>
- <span class="tag"><xs:attribute</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">null</span><span class="delimiter">"</span></span> <span class="attribute-name">use</span>=<span class="string"><span class="delimiter">"</span><span class="content">optional</span><span class="delimiter">"</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">"</span><span class="content">xs:boolean</span><span class="delimiter">"</span></span><span class="tag">/></span>
- <span class="tag"></xs:complexType></span>
-<span class="tag"></xs:schema></span></code></pre>
- </div>
- </div>
- <div class="colist arabic">
- <table>
- <tbody>
- <tr>
- <td><i class="conum" data-value="1"></i><b>1</b></td>
- <td>the aim schema has a namespace URI of "http://isis.apache.org/schema/aim". Although URIs are not the same as URLs, you will find that the schemas are also downloadable from this location.</td>
- </tr>
- <tr>
- <td><i class="conum" data-value="2"></i><b>2</b></td>
- <td>reuses the <a href="../rgcms/rgcms.html#_rgcms_schema-common">common</a> schema</td>
- </tr>
- <tr>
- <td><i class="conum" data-value="3"></i><b>3</b></td>
- <td>definition of the <code>actionInvocationMementoDto</code> complex type. This consists of metadata (the transaction identifier, the target object, the initiating user) and the payload (the action parameter/arguments, the return value if known).</td>
- </tr>
- <tr>
- <td><i class="conum" data-value="4"></i><b>4</b></td>
- <td>the unique transaction Id (a guid) allocated by the framework for each and every transaction</td>
- </tr>
- <tr>
- <td><i class="conum" data-value="5"></i><b>5</b></td>
- <td>a sequence number within the transaction. It is possible for there to be more than one action invocation to be</td>
- </tr>
- <tr>
- <td><i class="conum" data-value="6"></i><b>6</b></td>
- <td>when the action was invoked</td>
- </tr>
- <tr>
- <td><i class="conum" data-value="7"></i><b>7</b></td>
- <td>target object, as an OID (using <code>oidDto</code> from the <a href="../rgcms/rgcms.html#_rgcms_schema-common">common</a> schema)</td>
- </tr>
- <tr>
- <td><i class="conum" data-value="8"></i><b>8</b></td>
- <td>fully qualified class name of the target object, for information only</td>
- </tr>
- <tr>
- <td><i class="conum" data-value="9"></i><b>9</b></td>
- <td>name of the action, for information only</td>
- </tr>
- <tr>
- <td><i class="conum" data-value="10"></i><b>10</b></td>
- <td>Javadoc style unique identifier for the action.</td>
- </tr>
- <tr>
- <td><i class="conum" data-value="11"></i><b>11</b></td>
- <td>User that invoked the action</td>
- </tr>
- <tr>
- <td><i class="conum" data-value="12"></i><b>12</b></td>
- <td>title of the target object, for information only</td>
- </tr>
- <tr>
- <td><i class="conum" data-value="13"></i><b>13</b></td>
- <td>Collection of parameter/arguments, defined in terms of the <code>paramDto</code> complex type (discussed just below)</td>
- </tr>
- <tr>
- <td><i class="conum" data-value="14"></i><b>14</b></td>
- <td>The return value of the action, if known (and not void)</td>
- </tr>
- <tr>
- <td><i class="conum" data-value="15"></i><b>15</b></td>
- <td>The <code>paramDto</code> defines both an action parameter and its corresponding argument values</td>
- </tr>
- <tr>
- <td><i class="conum" data-value="16"></i><b>16</b></td>
- <td>The value of the parameter, in other words an argument value</td>
- </tr>
- <tr>
- <td><i class="conum" data-value="17"></i><b>17</b></td>
- <td>Metadata about the parameter itself: its name, type, optionality.</td>
- </tr>
- </tbody>
- </table>
+ <p>The schema was removed in <code>1.13.0</code>, and was replaced by:</p>
</div>
- <div class="admonitionblock note">
- <table>
- <tbody>
- <tr>
- <td class="icon"> <i class="fa icon-note" title="Note"></i> </td>
- <td class="content">
- <div class="paragraph">
- <p>As of <code>1.11.0</code> through <code>1.12.2</code> this schema is not used directly by the framework; in particular <code>Command#setMemento(…)</code> sets a similar but less formal XML structure. This may change in the future.</p>
- </div> </td>
- </tr>
- </tbody>
- </table>
+ <div class="ulist">
+ <ul>
+ <li> <p><a href="../rgcms/rgcms.html#_rgcms_schema-ixn">ixn.xsd</a></p>
+ <div class="paragraph">
+ <p>for action invocations/property edits, and</p>
+ </div> </li>
+ <li> <p><a href="../rgcms/rgcms.html#_rgcms_schema-cmd">cmd.xsd</a></p>
+ <div class="paragraph">
+ <p>for commands, ie the <em>intention</em> to invoke an action/edit a property.</p>
+ </div> </li>
+ </ul>
</div>
</div>
<div class="sect2">