Cinematic M2Doc services evolutions

ObeoNetwork · Dec 19, 2018 · b438633 · b438633
1 parent 9903bad
commit b438633
Show file tree

Hide file tree

Showing 38 changed files with 1,660 additions and 23 deletions.
diff --git a/m2doc/cinematic/plugins/org.obeonetwork.cinematic.m2doc.services/META-INF/MANIFEST.MF b/m2doc/cinematic/plugins/org.obeonetwork.cinematic.m2doc.services/META-INF/MANIFEST.MF
@@ -11,5 +11,7 @@ Require-Bundle: org.obeonetwork.m2doc.ide;bundle-version="2.0.0",
  org.obeonetwork.dsl.cinematic.design;bundle-version="10.0.0",
  org.obeonetwork.dsl.cinematic.edit;bundle-version="10.0.0",
  org.eclipse.acceleo.annotations,
- org.eclipse.help
+ org.eclipse.help,
+ org.obeonetwork.dsl.requirement;bundle-version="10.0.0",
+ org.obeonetwork.tools.doc
 Export-Package: org.obeonetwork.cinematic.m2doc.services
diff --git a/m2doc/cinematic/plugins/org.obeonetwork.cinematic.m2doc.services/doc/pages/index.html b/m2doc/cinematic/plugins/org.obeonetwork.cinematic.m2doc.services/doc/pages/index.html
@@ -59,6 +59,7 @@ <h1>Documentation of M2Doc Services for the Cinematic package</h1>
     <li>M2Doc Services and Attributes for <a href="./m2doc_services_abortstate.html">AbortState</a></li>
     <li>M2Doc Services and Attributes for <a href="./m2doc_services_abstractpackage.html">AbstractPackage</a></li>
     <li>M2Doc Services and Attributes for <a href="./m2doc_services_actionstate.html">ActionState</a></li>
+    <li>M2Doc Services and Attributes for <a href="./m2doc_services_annotation.html">Annotation</a></li>
     <li>M2Doc Services and Attributes for <a href="./m2doc_services_asynceventstate.html">AsyncEventState</a></li>
     <li>M2Doc Services and Attributes for <a href="./m2doc_services_cinematicroot.html">CinematicRoot</a></li>
     <li>M2Doc Services and Attributes for <a href="./m2doc_services_decisionstate.html">DecisionState</a></li>
@@ -67,8 +68,11 @@ <h1>Documentation of M2Doc Services for the Cinematic package</h1>
     <li>M2Doc Services and Attributes for <a href="./m2doc_services_flow.html">Flow</a></li>
     <li>M2Doc Services and Attributes for <a href="./m2doc_services_flowaction.html">FlowAction</a></li>
     <li>M2Doc Services and Attributes for <a href="./m2doc_services_flowevent.html">FlowEvent</a></li>
+    <li>M2Doc Services and Attributes for <a href="./m2doc_services_flowstate.html">FlowState</a></li>
     <li>M2Doc Services and Attributes for <a href="./m2doc_services_initialstate.html">InitialState</a></li>
+    <li>M2Doc Services and Attributes for <a href="./m2doc_services_obeodsmobject.html">ObeoDSMObject</a></li>
     <li>M2Doc Services and Attributes for <a href="./m2doc_services_package.html">Package</a></li>
+    <li>M2Doc Services and Attributes for <a href="./m2doc_services_requirement.html">Requirement</a></li>
     <li>M2Doc Services and Attributes for <a href="./m2doc_services_subflowstate.html">SubflowState</a></li>
     <li>M2Doc Services and Attributes for <a href="./m2doc_services_toolkit.html">Toolkit</a></li>
     <li>M2Doc Services and Attributes for <a href="./m2doc_services_transition.html">Transition</a></li>

diff --git a/...plugins/org.obeonetwork.cinematic.m2doc.services/doc/pages/m2doc_services_abortstate.html b/...plugins/org.obeonetwork.cinematic.m2doc.services/doc/pages/m2doc_services_abortstate.html
@@ -139,6 +139,13 @@ <h2 id="Services">Services</h2>
       </tr>
     </thead>
   <tbody>
+    <tr>
+      <td colspan="1" rowspan="1"><strong>allRelatedRequirements</strong></td>
+      <td colspan="1" rowspan="1">List of Requirement</td>
+      <td colspan="1" rowspan="1">{m:obj.allRelatedRequirements()}</td>
+      <td colspan="1" rowspan="1">Returns a list of all the Requirements related to the target object or one of its sub objects. The result is a list with no duplicates sorted against the requirements ids.</td>
+      <td colspan="1" rowspan="1">{m:obj.allRelatedRequirements()->sep(',')} returns: A comma separated list of related requirements.</td>
+    </tr>
     <tr>
       <td colspan="1" rowspan="1"><strong>cinematicIcon</strong></td>
       <td colspan="1" rowspan="1">org.obeonetwork.m2doc.element.MImage</td>
@@ -153,13 +160,55 @@ <h2 id="Services">Services</h2>
       <td colspan="1" rowspan="1">Returns the presentation label of the target Cinematic element.</td>
       <td colspan="1" rowspan="1">{m:obj.getCinematicLabel()} returns: The label of the element.</td>
     </tr>
+    <tr>
+      <td colspan="1" rowspan="1"><strong>getAnnotations</strong></td>
+      <td colspan="1" rowspan="1">List of Annotation</td>
+      <td colspan="1" rowspan="1">{m:flowEvent.getAnnotations()}</td>
+      <td colspan="1" rowspan="1">Returns the list of metadata annotations of the target Flow Event.</td>
+      <td colspan="1" rowspan="1">{m:flowEvent.getAnnotations().title->sep(',')} returns: A comma separated list of Flow Event's annotation titles.</td>
+    </tr>
+    <tr>
+      <td colspan="1" rowspan="1"><strong>getName</strong></td>
+      <td colspan="1" rowspan="1">String</td>
+      <td colspan="1" rowspan="1">{m:obj.getName()}</td>
+      <td colspan="1" rowspan="1">Returns the name of the given object if it defines one. Returns an empty string in all other cases.</td>
+      <td colspan="1" rowspan="1">{m:obj.getName()} returns: The object name.</td>
+    </tr>
+    <tr>
+      <td colspan="1" rowspan="1"><strong>getTypeName</strong></td>
+      <td colspan="1" rowspan="1">String</td>
+      <td colspan="1" rowspan="1">{m:obj.getTypeName()}</td>
+      <td colspan="1" rowspan="1">Returns the name of the given object's type, formatted with white spaces.</td>
+      <td colspan="1" rowspan="1">{m:obj.getTypeName()} returns: A string representation of the given object's type.</td>
+    </tr>
+    <tr>
+      <td colspan="1" rowspan="1"><strong>getViewContainers</strong></td>
+      <td colspan="1" rowspan="1">List of ViewContainer</td>
+      <td colspan="1" rowspan="1">{m:flowState.getViewContainers()}</td>
+      <td colspan="1" rowspan="1">If the target Flow State is a View State, returns the list of the referenced View Containers. Returns an empty list if the the target Flow State is not a View State.</td>
+      <td colspan="1" rowspan="1">{m:flowState.isNewInstance()} returns: The list of the referenced View Containers.</td>
+    </tr>
     <tr>
       <td colspan="1" rowspan="1"><strong>isCinematicObject</strong></td>
       <td colspan="1" rowspan="1">boolean</td>
       <td colspan="1" rowspan="1">{m:obj.isCinematicObject()}</td>
       <td colspan="1" rowspan="1">Returns if the target object is a Cinematic element.</td>
       <td colspan="1" rowspan="1">{m:obj.isCinematicObject()} returns: True if the target object is a Cinematic element, false otherwise.</td>
     </tr>
+    <tr>
+      <td colspan="1" rowspan="1"><strong>isNewInstance</strong></td>
+      <td colspan="1" rowspan="1">String</td>
+      <td colspan="1" rowspan="1">{m:flowState.isNewInstance()}</td>
+      <td colspan="1" rowspan="1">If the target Flow State is a View State, returns the string 'Oui' if it is a new instance and 'Non' if it is not. Returns 'N/A' if the the target Flow State is not a View State.</td>
+      <td colspan="1" rowspan="1">{m:flowState.isNewInstance()} returns: 'Oui' or 'Non' or 'N/A'.</td>
+    </tr>
+    <tr>
+      <td colspan="1" rowspan="1"><strong>isRefresh</strong></td>
+      <td colspan="1" rowspan="1">String</td>
+      <td colspan="1" rowspan="1">{m:flowState.isRefresh()}</td>
+      <td colspan="1" rowspan="1">If the target Flow State is a View State, returns the string 'Oui' if it is set to refresh and 'Non' if it is not. Returns 'N/A' if the the target Flow State is not a View State.</td>
+      <td colspan="1" rowspan="1">{m:flowState.isRefresh()} returns: 'Oui' or 'Non' or 'N/A'.</td>
+    </tr>
     <tr>
       <td colspan="1" rowspan="1"><strong>relatedRequirements</strong></td>
       <td colspan="1" rowspan="1">List of Requirement</td>

diff --git a/...ns/org.obeonetwork.cinematic.m2doc.services/doc/pages/m2doc_services_abstractpackage.html b/...ns/org.obeonetwork.cinematic.m2doc.services/doc/pages/m2doc_services_abstractpackage.html
@@ -46,6 +46,13 @@ <h2 id="Services">Services</h2>
       </tr>
     </thead>
   <tbody>
+    <tr>
+      <td colspan="1" rowspan="1"><strong>allRelatedRequirements</strong></td>
+      <td colspan="1" rowspan="1">List of Requirement</td>
+      <td colspan="1" rowspan="1">{m:obj.allRelatedRequirements()}</td>
+      <td colspan="1" rowspan="1">Returns a list of all the Requirements related to the target object or one of its sub objects. The result is a list with no duplicates sorted against the requirements ids.</td>
+      <td colspan="1" rowspan="1">{m:obj.allRelatedRequirements()->sep(',')} returns: A comma separated list of related requirements.</td>
+    </tr>
     <tr>
       <td colspan="1" rowspan="1"><strong>cinematicIcon</strong></td>
       <td colspan="1" rowspan="1">org.obeonetwork.m2doc.element.MImage</td>
@@ -60,6 +67,27 @@ <h2 id="Services">Services</h2>
       <td colspan="1" rowspan="1">Returns the presentation label of the target Cinematic element.</td>
       <td colspan="1" rowspan="1">{m:obj.getCinematicLabel()} returns: The label of the element.</td>
     </tr>
+    <tr>
+      <td colspan="1" rowspan="1"><strong>getAnnotations</strong></td>
+      <td colspan="1" rowspan="1">List of Annotation</td>
+      <td colspan="1" rowspan="1">{m:flowEvent.getAnnotations()}</td>
+      <td colspan="1" rowspan="1">Returns the list of metadata annotations of the target Flow Event.</td>
+      <td colspan="1" rowspan="1">{m:flowEvent.getAnnotations().title->sep(',')} returns: A comma separated list of Flow Event's annotation titles.</td>
+    </tr>
+    <tr>
+      <td colspan="1" rowspan="1"><strong>getName</strong></td>
+      <td colspan="1" rowspan="1">String</td>
+      <td colspan="1" rowspan="1">{m:obj.getName()}</td>
+      <td colspan="1" rowspan="1">Returns the name of the given object if it defines one. Returns an empty string in all other cases.</td>
+      <td colspan="1" rowspan="1">{m:obj.getName()} returns: The object name.</td>
+    </tr>
+    <tr>
+      <td colspan="1" rowspan="1"><strong>getTypeName</strong></td>
+      <td colspan="1" rowspan="1">String</td>
+      <td colspan="1" rowspan="1">{m:obj.getTypeName()}</td>
+      <td colspan="1" rowspan="1">Returns the name of the given object's type, formatted with white spaces.</td>
+      <td colspan="1" rowspan="1">{m:obj.getTypeName()} returns: A string representation of the given object's type.</td>
+    </tr>
     <tr>
       <td colspan="1" rowspan="1"><strong>isCinematicObject</strong></td>
       <td colspan="1" rowspan="1">boolean</td>

diff --git a/...lugins/org.obeonetwork.cinematic.m2doc.services/doc/pages/m2doc_services_actionstate.html b/...lugins/org.obeonetwork.cinematic.m2doc.services/doc/pages/m2doc_services_actionstate.html
@@ -139,6 +139,13 @@ <h2 id="Services">Services</h2>
       </tr>
     </thead>
   <tbody>
+    <tr>
+      <td colspan="1" rowspan="1"><strong>allRelatedRequirements</strong></td>
+      <td colspan="1" rowspan="1">List of Requirement</td>
+      <td colspan="1" rowspan="1">{m:obj.allRelatedRequirements()}</td>
+      <td colspan="1" rowspan="1">Returns a list of all the Requirements related to the target object or one of its sub objects. The result is a list with no duplicates sorted against the requirements ids.</td>
+      <td colspan="1" rowspan="1">{m:obj.allRelatedRequirements()->sep(',')} returns: A comma separated list of related requirements.</td>
+    </tr>
     <tr>
       <td colspan="1" rowspan="1"><strong>cinematicIcon</strong></td>
       <td colspan="1" rowspan="1">org.obeonetwork.m2doc.element.MImage</td>
@@ -153,20 +160,62 @@ <h2 id="Services">Services</h2>
       <td colspan="1" rowspan="1">Returns the presentation label of the target Cinematic element.</td>
       <td colspan="1" rowspan="1">{m:obj.getCinematicLabel()} returns: The label of the element.</td>
     </tr>
+    <tr>
+      <td colspan="1" rowspan="1"><strong>getAnnotations</strong></td>
+      <td colspan="1" rowspan="1">List of Annotation</td>
+      <td colspan="1" rowspan="1">{m:flowEvent.getAnnotations()}</td>
+      <td colspan="1" rowspan="1">Returns the list of metadata annotations of the target Flow Event.</td>
+      <td colspan="1" rowspan="1">{m:flowEvent.getAnnotations().title->sep(',')} returns: A comma separated list of Flow Event's annotation titles.</td>
+    </tr>
+    <tr>
+      <td colspan="1" rowspan="1"><strong>getName</strong></td>
+      <td colspan="1" rowspan="1">String</td>
+      <td colspan="1" rowspan="1">{m:obj.getName()}</td>
+      <td colspan="1" rowspan="1">Returns the name of the given object if it defines one. Returns an empty string in all other cases.</td>
+      <td colspan="1" rowspan="1">{m:obj.getName()} returns: The object name.</td>
+    </tr>
     <tr>
       <td colspan="1" rowspan="1"><strong>getOperations</strong></td>
       <td colspan="1" rowspan="1">List of Action</td>
       <td colspan="1" rowspan="1">{m:actionState.getOperations()}</td>
       <td colspan="1" rowspan="1">Returns the list of all the Operations attached to the target Action State (by way of Flow Actions).</td>
       <td colspan="1" rowspan="1">{m:actionState.getOperations()} returns: The list Operations attached to the target Action State.</td>
     </tr>
+    <tr>
+      <td colspan="1" rowspan="1"><strong>getTypeName</strong></td>
+      <td colspan="1" rowspan="1">String</td>
+      <td colspan="1" rowspan="1">{m:obj.getTypeName()}</td>
+      <td colspan="1" rowspan="1">Returns the name of the given object's type, formatted with white spaces.</td>
+      <td colspan="1" rowspan="1">{m:obj.getTypeName()} returns: A string representation of the given object's type.</td>
+    </tr>
+    <tr>
+      <td colspan="1" rowspan="1"><strong>getViewContainers</strong></td>
+      <td colspan="1" rowspan="1">List of ViewContainer</td>
+      <td colspan="1" rowspan="1">{m:flowState.getViewContainers()}</td>
+      <td colspan="1" rowspan="1">If the target Flow State is a View State, returns the list of the referenced View Containers. Returns an empty list if the the target Flow State is not a View State.</td>
+      <td colspan="1" rowspan="1">{m:flowState.isNewInstance()} returns: The list of the referenced View Containers.</td>
+    </tr>
     <tr>
       <td colspan="1" rowspan="1"><strong>isCinematicObject</strong></td>
       <td colspan="1" rowspan="1">boolean</td>
       <td colspan="1" rowspan="1">{m:obj.isCinematicObject()}</td>
       <td colspan="1" rowspan="1">Returns if the target object is a Cinematic element.</td>
       <td colspan="1" rowspan="1">{m:obj.isCinematicObject()} returns: True if the target object is a Cinematic element, false otherwise.</td>
     </tr>
+    <tr>
+      <td colspan="1" rowspan="1"><strong>isNewInstance</strong></td>
+      <td colspan="1" rowspan="1">String</td>
+      <td colspan="1" rowspan="1">{m:flowState.isNewInstance()}</td>
+      <td colspan="1" rowspan="1">If the target Flow State is a View State, returns the string 'Oui' if it is a new instance and 'Non' if it is not. Returns 'N/A' if the the target Flow State is not a View State.</td>
+      <td colspan="1" rowspan="1">{m:flowState.isNewInstance()} returns: 'Oui' or 'Non' or 'N/A'.</td>
+    </tr>
+    <tr>
+      <td colspan="1" rowspan="1"><strong>isRefresh</strong></td>
+      <td colspan="1" rowspan="1">String</td>
+      <td colspan="1" rowspan="1">{m:flowState.isRefresh()}</td>
+      <td colspan="1" rowspan="1">If the target Flow State is a View State, returns the string 'Oui' if it is set to refresh and 'Non' if it is not. Returns 'N/A' if the the target Flow State is not a View State.</td>
+      <td colspan="1" rowspan="1">{m:flowState.isRefresh()} returns: 'Oui' or 'Non' or 'N/A'.</td>
+    </tr>
     <tr>
       <td colspan="1" rowspan="1"><strong>relatedRequirements</strong></td>
       <td colspan="1" rowspan="1">List of Requirement</td>