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/06/28 10:16:16 UTC
[05/12] isis-site git commit: ISIS-1613 and ISIS-1633
http://git-wip-us.apache.org/repos/asf/isis-site/blob/41911010/content/guides/rgcms/rgcms.html
----------------------------------------------------------------------
diff --git a/content/guides/rgcms/rgcms.html b/content/guides/rgcms/rgcms.html
index 21ec15a..05bdef5 100644
--- a/content/guides/rgcms/rgcms.html
+++ b/content/guides/rgcms/rgcms.html
@@ -6427,13 +6427,15 @@ table.CodeRay td.code>pre{padding:0}
<pre class="CodeRay highlight"><code data-lang="xml"><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/cmd</span><span class="delimiter">"</span></span> <span class="attribute-name">...</span><span class="tag">></span>
...
<span class="tag"><xs:complexType</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">memberDto</span><span class="delimiter">"</span></span> <span class="attribute-name">abstract</span>=<span class="string"><span class="delimiter">"</span><span class="content">true</span><span class="delimiter">"</span></span><span class="tag">></span> <i class="conum" data-value="1"></i><b>(1)</b>
+ <span class="tag"></xs:element></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">memberIdentifier</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>
+ <span class="tag"><xs:element</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">memberIdentifier</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="2"></i><b>(2)</b>
+ <span class="tag"><xs:element</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">logicalMemberIdentifier</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="3"></i><b>(3)</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">interactionType</span><span class="delimiter">"</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">"</span><span class="content">com:interactionType</span><span class="delimiter">"</span></span><span class="tag">/></span> <i class="conum" data-value="2"></i><b>(2)</b>
+ <span class="tag"><xs:attribute</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">interactionType</span><span class="delimiter">"</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">"</span><span class="content">com:interactionType</span><span class="delimiter">"</span></span><span class="tag">/></span> <i class="conum" data-value="4"></i><b>(4)</b>
<span class="tag"></xs:complexType></span>
- <span class="tag"><xs:complexType</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">actionDto</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="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">actionDto</span><span class="delimiter">"</span></span><span class="tag">></span> <i class="conum" data-value="5"></i><b>(5)</b>
<span class="tag"><xs:complexContent></span>
<span class="tag"><xs:extension</span> <span class="attribute-name">base</span>=<span class="string"><span class="delimiter">"</span><span class="content">memberDto</span><span class="delimiter">"</span></span><span class="tag">></span>
<span class="tag"><xs:sequence></span>
@@ -6443,7 +6445,7 @@ table.CodeRay td.code>pre{padding:0}
<span class="tag"></xs:complexContent></span>
<span class="tag"></xs:complexType></span>
- <span class="tag"><xs:complexType</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">propertyDto</span><span class="delimiter">"</span></span><span class="tag">></span> <i class="conum" data-value="4"></i><b>(4)</b>
+ <span class="tag"><xs:complexType</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">propertyDto</span><span class="delimiter">"</span></span><span class="tag">></span> <i class="conum" data-value="6"></i><b>(6)</b>
<span class="tag"><xs:complexContent></span>
<span class="tag"><xs:extension</span> <span class="attribute-name">base</span>=<span class="string"><span class="delimiter">"</span><span class="content">memberDto</span><span class="delimiter">"</span></span><span class="tag">></span>
<span class="tag"><xs:sequence></span>
@@ -6464,20 +6466,31 @@ table.CodeRay td.code>pre{padding:0}
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
- <td>the <code>interactionType</code> attribute indicates whether the member is an action or a property.</td>
+ <td>the formal identifier (fully qualified class name + member name) of the member being interacted with (action or property).</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
- <td>the <code>actionDto</code> complex type captures the set of parameters (also including the argument values) with which to invoke the action. The <code>paramsDto</code> type is defined <a href="../rgcms/rgcms.html#__rgcms_schema-cmd_ancillary">below</a>.</td>
+ <td>(<code>1.15.0-SNAPSHOT</code>) the "logical" formal identifier (object type, as per <code>@DomainObject(objectType=)</code>, + member name) of the member being interacted with (action or property).</td>
</tr>
<tr>
<td><i class="conum" data-value="4"></i><b>4</b></td>
+ <td>the <code>interactionType</code> attribute indicates whether the member is an action or a property.</td>
+ </tr>
+ <tr>
+ <td><i class="conum" data-value="5"></i><b>5</b></td>
+ <td>the <code>actionDto</code> complex type captures the set of parameters (also including the argument values) with which to invoke the action. The <code>paramsDto</code> type is defined <a href="../rgcms/rgcms.html#__rgcms_schema-cmd_ancillary">below</a>.</td>
+ </tr>
+ <tr>
+ <td><i class="conum" data-value="6"></i><b>6</b></td>
<td>the <code>propertyDto</code> complex type captures the new value (possibly <code>null</code>) to set the property to.</td>
</tr>
</tbody>
</table>
</div>
<div class="paragraph">
+ <p>In general the <code>logicalMemberIdentifier</code> (<code>1.15.0-SNAPSHOT</code>) should be used in preference to the <code>memberIdentifier</code> because will not (necessarily) have to change if the class is moved during a refactoring.</p>
+ </div>
+ <div class="paragraph">
<p>Note also that there is a corresponding <a href="../rgcms/rgcms.html#__rgcms_schema-ixn_memberExecutionDto"><code>memberExecutionDto</code></a> complex type in the "ixn" schema that is for the actual execution (capturing metrics about its execution and also the return value if an action invocation).</p>
</div>
</div>
@@ -6637,12 +6650,13 @@ table.CodeRay td.code>pre{padding:0}
<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="2"></i><b>(2)</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">com:oidDto</span><span class="delimiter">"</span></span><span class="tag">/></span> <i class="conum" data-value="3"></i><b>(3)</b>
<span class="tag"><xs:element</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">memberIdentifier</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">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="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">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="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">metrics</span><span class="delimiter">"</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">"</span><span class="content">metricsDto</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">threw</span><span class="delimiter">"</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">"</span><span class="content">exceptionDto</span><span class="delimiter">"</span></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">logicalMemberIdentifier</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="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">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="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">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="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">metrics</span><span class="delimiter">"</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">"</span><span class="content">metricsDto</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">threw</span><span class="delimiter">"</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">"</span><span class="content">exceptionDto</span><span class="delimiter">"</span></span> <i class="conum" data-value="9"></i><b>(9)</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:element</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">childExecutions</span><span class="delimiter">"</span></span> <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> <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">childExecutions</span><span class="delimiter">"</span></span> <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> <i class="conum" data-value="10"></i><b>(10)</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">execution</span><span class="delimiter">"</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">"</span><span class="content">memberExecutionDto</span><span class="delimiter">"</span></span>
@@ -6651,7 +6665,7 @@ table.CodeRay td.code>pre{padding:0}
<span class="tag"></xs:complexType></span>
<span class="tag"></xs:element></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">interactionType</span><span class="delimiter">"</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">"</span><span class="content">com:interactionType</span><span class="delimiter">"</span></span><span class="tag">/></span> <i class="conum" data-value="10"></i><b>(10)</b>
+ <span class="tag"><xs:attribute</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">interactionType</span><span class="delimiter">"</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">"</span><span class="content">com:interactionType</span><span class="delimiter">"</span></span><span class="tag">/></span> <i class="conum" data-value="11"></i><b>(11)</b>
<span class="tag"></xs:complexType></span>
...
<span class="tag"></xs:schema></span></code></pre>
@@ -6678,32 +6692,39 @@ table.CodeRay td.code>pre{padding:0}
</tr>
<tr>
<td><i class="conum" data-value="5"></i><b>5</b></td>
- <td>the user executing the action invocation/property edit; corresponds to the <code>user</code> element of the <a href="../rgcms/rgcms.html#__rgcms_schema-cmd_memberDto"><code>memberDto</code></a></td>
+ <td>(<code>1.15.0-SNAPSHOT</code>) the <em>logical</em> member identifier; corresponds to <code>logicalMemberIdentifier</code> of the <code>member</code> element of the <a href="../rgcms/rgcms.html#__rgcms_schema-cmd_memberDto"><code>memberDto</code></a></td>
</tr>
<tr>
<td><i class="conum" data-value="6"></i><b>6</b></td>
- <td>the current "human-friendly" title of the target object</td>
+ <td>the user executing the action invocation/property edit; corresponds to the <code>user</code> element of the <a href="../rgcms/rgcms.html#__rgcms_schema-cmd_memberDto"><code>memberDto</code></a></td>
</tr>
<tr>
<td><i class="conum" data-value="7"></i><b>7</b></td>
- <td>the set of metrics captured for this execution, of type <code>metricsDto</code> defined <a href="../rgcms/rgcms.html#__rgcms_schema-ixn_ancillary">below</a>.</td>
+ <td>the current "human-friendly" title of the target object</td>
</tr>
<tr>
<td><i class="conum" data-value="8"></i><b>8</b></td>
- <td>if the action invocation/property edit threw an exception, then this is captured here.</td>
+ <td>the set of metrics captured for this execution, of type <code>metricsDto</code> defined <a href="../rgcms/rgcms.html#__rgcms_schema-ixn_ancillary">below</a>.</td>
</tr>
<tr>
<td><i class="conum" data-value="9"></i><b>9</b></td>
- <td>if any sub-actions or sub-edits were performed via the <a href="../rgsvc/rgsvc.html#_rgsvc_application-layer-api_WrapperFactory"><code>WrapperFactory</code></a>, then these are captured in the <code>childExecutions</code> element.</td>
+ <td>if the action invocation/property edit threw an exception, then this is captured here.</td>
</tr>
<tr>
<td><i class="conum" data-value="10"></i><b>10</b></td>
+ <td>if any sub-actions or sub-edits were performed via the <a href="../rgsvc/rgsvc.html#_rgsvc_application-layer-api_WrapperFactory"><code>WrapperFactory</code></a>, then these are captured in the <code>childExecutions</code> element.</td>
+ </tr>
+ <tr>
+ <td><i class="conum" data-value="11"></i><b>11</b></td>
<td>the <code>interactionType</code> attribute indicates whether the member is an action or a property (similar attribute exists for the "cmd" schema).</td>
</tr>
</tbody>
</table>
</div>
<div class="paragraph">
+ <p>In general the <code>logicalMemberIdentifier</code> (<code>1.15.0-SNAPSHOT</code>) should be used in preference to the <code>memberIdentifier</code> because will not (necessarily) have to change if the class is moved during a refactoring.</p>
+ </div>
+ <div class="paragraph">
<p>The <code>actionInvocationDto</code> and <code>propertyEditDto</code> are the concrete subtypes:</p>
</div>
<div class="listingblock">