summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVrishali Doke2012-05-08 04:48:56 (EDT)
committer Stephan Born2012-06-15 10:40:15 (EDT)
commit9e2c1f6a7e46bad24a33744bf56b9bef201c4d33 (patch)
tree84069a6702209d00b977457dc8a946209ad38c8a
parent15c519e1ecca73a499dc99100b7066a8607f329b (diff)
downloadorg.eclipse.stardust.documentation-9e2c1f6a7e46bad24a33744bf56b9bef201c4d33.zip
org.eclipse.stardust.documentation-9e2c1f6a7e46bad24a33744bf56b9bef201c4d33.tar.gz
org.eclipse.stardust.documentation-9e2c1f6a7e46bad24a33744bf56b9bef201c4d33.tar.bz2
CRNT-24698 - Added details related to PerferenceQuery and Preferences
git-svn-id: http://emeafrazerg/svn/ipp/product/trunk/stardust/documentation@56160 8100b5e0-4d52-466c-ae9c-bdeccbdeaf6b
-rw-r--r--org.eclipse.stardust.docs.dev/html/handbooks/programming/pg-webservice-classes.html59
-rw-r--r--org.eclipse.stardust.docs.dev/html/handbooks/programming/pg-webservice-queries.html50
2 files changed, 109 insertions, 0 deletions
diff --git a/org.eclipse.stardust.docs.dev/html/handbooks/programming/pg-webservice-classes.html b/org.eclipse.stardust.docs.dev/html/handbooks/programming/pg-webservice-classes.html
index 0e75416..fed8081 100644
--- a/org.eclipse.stardust.docs.dev/html/handbooks/programming/pg-webservice-classes.html
+++ b/org.eclipse.stardust.docs.dev/html/handbooks/programming/pg-webservice-classes.html
@@ -327,6 +327,48 @@ information on examples provided by @productname@.</p>
<td>-</td>
</tr>
+ <tr>
+ <td>Preferences <strong>getPreferences</strong>(PreferenceScope scope, String moduleId, String preferencesId)
+ </td>
+ <td>PreferencesXto getPreferences(PreferencesScopeXto scope, String moduleId, String preferencesId)
+ </td>
+ <td>-</td>
+ </tr>
+ <tr>
+ <td>void <strong>savePreferences</strong>(Preferences preferences)</td>
+ <td></td>
+ <td>use savePreferences(PreferencesListXto preferences)</td>
+ </tr>
+ <tr>
+ <td>void <strong>savePreferences</strong>(List&lt;Preferences&gt; preferences)</td>
+ <td>void savePreferences(PreferencesListXto preferences) </td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>ConfigurationVariables <strong>getConfigurationVariables</strong>(String modelId)
+ </td>
+ <td>List&lt;ConfigurationVariables&gt; <strong>getConfigurationVariables</strong>(List&lt;String&gt; modelIds)
+ </td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>ConfigurationVariables <strong>getConfigurationVariables</strong>(byte[] model)
+ </td>
+ <td>List&lt;ModelReconfigurationInfo&gt; <strong>saveConfigurationVariables</strong>(ConfigurationVariables configurationVariables, boolean force)
+ </td>
+ <td></td>
+
+ </tr>
+ <tr>
+ <td>RuntimePermissions <strong>getGlobalPermissions</strong>()
+ </td>
+ <td>void <strong>setGlobalPermissions</strong>(RuntimePermissions permissions)
+ </td>
+ <td></td>
+
+ </tr>
+
</table>
<h2 id="document">DocumentManagementService</h2>
<table id="DocumentManagementService">
@@ -868,6 +910,23 @@ information on examples provided by @productname@.</p>
</td>
</tr>
+ <tr>
+
+ <td>Preferences <strong>getPreferences</strong>(PreferenceScope scope, String moduleId, String preferencesId)
+ </td>
+ <td>
+ PreferencesXto getPreferences (PreferencesScopeXto scope, String moduleId, String preferencesId)
+ </td>
+ <td></td>
+
+ </tr>
+ <tr>
+ <td>List &lt;Preferences&gt; <strong>getAllPreferences</strong>(PreferenceQuery preferenceQuery)</td>
+ <td>PreferencesListXto findPreferences(PreferencesQueryXto query)</td>
+ <td></td>
+
+ </tr>
+
</table>
<h2 id="user">UserService</h2>
<table id="UserService">
diff --git a/org.eclipse.stardust.docs.dev/html/handbooks/programming/pg-webservice-queries.html b/org.eclipse.stardust.docs.dev/html/handbooks/programming/pg-webservice-queries.html
index 99c639d..3f803ed 100644
--- a/org.eclipse.stardust.docs.dev/html/handbooks/programming/pg-webservice-queries.html
+++ b/org.eclipse.stardust.docs.dev/html/handbooks/programming/pg-webservice-queries.html
@@ -296,6 +296,7 @@ available attributes and policies.</p>
<li><a href="#procDefQuery">ProcessDefinitionQuery</a></li>
<li><a href="#docQuery">DocumentQuery</a></li>
<li><a href="#data">DataQuery</a></li>
+ <li><a href="#prefer">PreferencesQuery</a></li>
</ul>
<h3 id="worklistQuery">WorklistQuery</h3>
<p>For the worklist query primarily <tt>userContribution</tt> is
@@ -915,6 +916,55 @@ where(FilterCriterion)
</tr>
</table>
+
+<h3 id="prefer">PreferencesQuery</h3>
+
+<table>
+ <tr>
+ <th>PreferencesQuery</th>
+ <th>Mapped Structure</th>
+ <th>Comments</th>
+ </tr>
+ <tr>
+ <td>getFilter()
+where(FilterCriterion) </td>
+ <td>&lt;element name="AndTerm" minOccurs="0" /&gt;</td>
+ <td>See section about <a href="#pterm">PredicateTerm</a>.<br>Supported:
+ <ul>
+ <li>FilterAndTerm</li>
+ <li>FilterOrTerm </li>
+ <li>UnaryOperatorFilter</li>
+ <li>BinaryOperatorFilter</li>
+ <li>TernaryOperatorFilter</li></ul>
+ </td>
+ </tr>
+ <tr>
+ <td>getOrderCriteria()<br>
+ orderBy(OrderCriterion)<br>
+ orderBy(FilterableAttribute)<br>
+ orderBy(FilterableAttribute, boolean)</td>
+ <td>&lt;element name="OrderCriteria" minOccurs="0" /&gt;</td>
+ <td>Works as a list of OrderCriteria which consists of AttributeOrder or DataOrder elements.
+ Supported Attributes are:<br>
+ <ul>
+ <li>scope</li>
+ <li>moduleId</li>
+ <li>preferencesId</li>
+ <li>realmId</li>
+ <li>userId</li></ul>
+ </td>
+ </tr>
+ <tr>
+ <td>getPolicy(Class)<br>
+setPolicy(EvaluationPolicy)<br>
+removePolicy(Class) </td>
+ <td>&lt;element name="Policy" minOccurs="0" /&gt; </td>
+ <td>No policies are supported.</td>
+ </tr>
+
+</table>
+
+
<h3 id="pterm">PredicateTerm Building</h3>
<pre>
&lt;!-- filter terms --&gt;