You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@chemistry.apache.org by ga...@apache.org on 2015/04/06 19:12:15 UTC
svn commit: r1671598 [10/34] - in
/chemistry/site/trunk/content/java/0.13.0/maven/chemistry-opencmis-server:
./ chemistry-opencmis-server-support/ chemistry-opencmis-server-support/css/
chemistry-opencmis-server-support/images/ chemistry-opencmis-serve...
Added: chemistry/site/trunk/content/java/0.13.0/maven/chemistry-opencmis-server/chemistry-opencmis-server-support/xref/org/apache/chemistry/opencmis/server/support/TypeManager.html
URL: http://svn.apache.org/viewvc/chemistry/site/trunk/content/java/0.13.0/maven/chemistry-opencmis-server/chemistry-opencmis-server-support/xref/org/apache/chemistry/opencmis/server/support/TypeManager.html?rev=1671598&view=auto
==============================================================================
--- chemistry/site/trunk/content/java/0.13.0/maven/chemistry-opencmis-server/chemistry-opencmis-server-support/xref/org/apache/chemistry/opencmis/server/support/TypeManager.html (added)
+++ chemistry/site/trunk/content/java/0.13.0/maven/chemistry-opencmis-server/chemistry-opencmis-server-support/xref/org/apache/chemistry/opencmis/server/support/TypeManager.html Mon Apr 6 17:12:14 2015
@@ -0,0 +1,122 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
+<title>TypeManager xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../apidocs/org/apache/chemistry/opencmis/server/support/TypeManager.html">View Javadoc</a></div><pre>
+
+<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
+<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
+<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
+<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
+<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
+<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
+<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
+<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
+<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
+<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
+<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
+<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
+<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
+<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
+<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em>
+<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
+<a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.chemistry.opencmis.server.support;
+<a class="jxr_linenumber" name="20" href="#20">20</a>
+<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.util.Collection;
+<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.util.List;
+<a class="jxr_linenumber" name="23" href="#23">23</a>
+<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.definitions.TypeDefinition;
+<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.definitions.TypeDefinitionContainer;
+<a class="jxr_linenumber" name="26" href="#26">26</a>
+<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../../org/apache/chemistry/opencmis/server/support/TypeManager.html">TypeManager</a> {
+<a class="jxr_linenumber" name="28" href="#28">28</a>
+<a class="jxr_linenumber" name="29" href="#29">29</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * return a type definition from the type definition id</em>
+<a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * </em>
+<a class="jxr_linenumber" name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * @param typeId</em>
+<a class="jxr_linenumber" name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * id of the type definition</em>
+<a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * @return type definition for this id</em>
+<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="36" href="#36">36</a> TypeDefinitionContainer getTypeById(String typeId);
+<a class="jxr_linenumber" name="37" href="#37">37</a>
+<a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * return a type definition from the type query name or null if not found</em>
+<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * </em>
+<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @param typeQueryName</em>
+<a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * query name of the type definition</em>
+<a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * @return type definition for this query name</em>
+<a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="45" href="#45">45</a> TypeDefinition getTypeByQueryName(String typeQueryName);
+<a class="jxr_linenumber" name="46" href="#46">46</a>
+<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * return a list of all types known in this repository</em>
+<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * Note: This method is not needed for the query parser.</em>
+<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * </em>
+<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * @return</em>
+<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * list of type definitions</em>
+<a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="54" href="#54">54</a> Collection<TypeDefinitionContainer> getTypeDefinitionList();
+<a class="jxr_linenumber" name="55" href="#55">55</a>
+<a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * return a list of the root types as defined in the CMIS spec (for</em>
+<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * document, folder, policy and relationship</em>
+<a class="jxr_linenumber" name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * Note: This method is not needed for the query parser.</em>
+<a class="jxr_linenumber" name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * </em>
+<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * @return</em>
+<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * list of type definitions</em>
+<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="64" href="#64">64</a> List<TypeDefinitionContainer> getRootTypes();
+<a class="jxr_linenumber" name="65" href="#65">65</a>
+<a class="jxr_linenumber" name="66" href="#66">66</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * retrieve the property id from a type for a given property query name </em>
+<a class="jxr_linenumber" name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * </em>
+<a class="jxr_linenumber" name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * @param typeDefinition</em>
+<a class="jxr_linenumber" name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * type definition containing query name</em>
+<a class="jxr_linenumber" name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * @param propQueryName</em>
+<a class="jxr_linenumber" name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * query name of property</em>
+<a class="jxr_linenumber" name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * @return</em>
+<a class="jxr_linenumber" name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * property id of property or null if not found</em>
+<a class="jxr_linenumber" name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="76" href="#76">76</a> String getPropertyIdForQueryName(TypeDefinition typeDefinition, String propQueryName);
+<a class="jxr_linenumber" name="77" href="#77">77</a>
+<a class="jxr_linenumber" name="78" href="#78">78</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * Add a type to the type system. Add all properties from inherited types,</em>
+<a class="jxr_linenumber" name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * add type to children of parent types.</em>
+<a class="jxr_linenumber" name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * Note: This method is not needed for the query parser.</em>
+<a class="jxr_linenumber" name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * </em>
+<a class="jxr_linenumber" name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * @param typeDefinition</em>
+<a class="jxr_linenumber" name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * new type to add</em>
+<a class="jxr_linenumber" name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * @param addInheritedProperties</em>
+<a class="jxr_linenumber" name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * add properties from supertype to type definition</em>
+<a class="jxr_linenumber" name="87" href="#87">87</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="88" href="#88">88</a> <strong class="jxr_keyword">void</strong> addTypeDefinition(TypeDefinition typeDefinition, <strong class="jxr_keyword">boolean</strong> addInheritedProperties);
+<a class="jxr_linenumber" name="89" href="#89">89</a>
+<a class="jxr_linenumber" name="90" href="#90">90</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * Modify an existing type definition.</em>
+<a class="jxr_linenumber" name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * Note: This method is not needed for the query parser.</em>
+<a class="jxr_linenumber" name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * </em>
+<a class="jxr_linenumber" name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * @param typeDefinition</em>
+<a class="jxr_linenumber" name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * type to be modified</em>
+<a class="jxr_linenumber" name="96" href="#96">96</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="97" href="#97">97</a> <strong class="jxr_keyword">void</strong> updateTypeDefinition(TypeDefinition typeDefinition);
+<a class="jxr_linenumber" name="98" href="#98">98</a>
+<a class="jxr_linenumber" name="99" href="#99">99</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * Delete a type from the type system. Delete will succeed only if type is</em>
+<a class="jxr_linenumber" name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * not in use. Otherwise an exception is thrown.</em>
+<a class="jxr_linenumber" name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * Note: This method is not needed for the query parser.</em>
+<a class="jxr_linenumber" name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * </em>
+<a class="jxr_linenumber" name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * @param typeId</em>
+<a class="jxr_linenumber" name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * id of type to be deleted</em>
+<a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="107" href="#107">107</a> <strong class="jxr_keyword">void</strong> deleteTypeDefinition(String typeId);
+<a class="jxr_linenumber" name="108" href="#108">108</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+