| <!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>ObjectStore xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../../../apidocs/org/apache/chemistry/opencmis/inmemory/storedobj/api/ObjectStore.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.inmemory.storedobj.api; |
| <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.List; |
| <a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.util.Map; |
| <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.data.Acl; |
| <a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.data.ContentStream; |
| <a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.data.PropertyData; |
| <a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.enums.AclPropagation; |
| <a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.enums.IncludeRelationships; |
| <a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.enums.RelationshipDirection; |
| <a class="jxr_linenumber" name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.enums.VersioningState; |
| <a class="jxr_linenumber" name="31" href="#31">31</a> |
| <a class="jxr_linenumber" name="32" href="#32">32</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * @author Jens</em> |
| <a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * This is the interface an implementation must provide to store any</em> |
| <a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * kind of CMIS objects. The ObjectStore is the topmost container of all</em> |
| <a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * CMIS object that get persisted. It is comparable to a file system,</em> |
| <a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * one object store exists per repository id. The object store allows</em> |
| <a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * access objects by an id. In addition a object can be retrieved by</em> |
| <a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * path. Typically the object store owns the list of object ids and</em> |
| <a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * maintains the path hierarchy.</em> |
| <a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="43" href="#43">43</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/ObjectStore.html">ObjectStore</a> { |
| <a class="jxr_linenumber" name="44" href="#44">44</a> |
| <a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * Get the root folder of this object store</em> |
| <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 the root folder of this store</em> |
| <a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="50" href="#50">50</a> <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Folder.html">Folder</a> getRootFolder(); |
| <a class="jxr_linenumber" name="51" href="#51">51</a> |
| <a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * return an object by path.</em> |
| <a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * @param path</em> |
| <a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * the path to the object</em> |
| <a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * @return the stored object with this path</em> |
| <a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="59" href="#59">59</a> <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html">StoredObject</a> getObjectByPath(String path, String user); |
| <a class="jxr_linenumber" name="60" href="#60">60</a> |
| <a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * get an object by its id</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> <em class="jxr_javadoccomment"> * @param folderId</em> |
| <a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * the id of the object</em> |
| <a class="jxr_linenumber" name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * @return the object identified by this id</em> |
| <a class="jxr_linenumber" name="67" href="#67">67</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="68" href="#68">68</a> <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html">StoredObject</a> getObjectById(String folderId); |
| <a class="jxr_linenumber" name="69" href="#69">69</a> |
| <a class="jxr_linenumber" name="70" href="#70">70</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * Deletes an object from the store. For a folders the folder must be empty.</em> |
| <a class="jxr_linenumber" name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * @param objectId</em> |
| <a class="jxr_linenumber" name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * @param user </em> |
| <a class="jxr_linenumber" name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * @param allVersions is TRUE all version of the document are deleted, otherwise just this one</em> |
| <a class="jxr_linenumber" name="76" href="#76">76</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="77" href="#77">77</a> <strong class="jxr_keyword">void</strong> deleteObject(String objectId, Boolean allVersions, String user); |
| <a class="jxr_linenumber" name="78" href="#78">78</a> |
| <a class="jxr_linenumber" name="79" href="#79">79</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * Create a document as initial step. The document is created but still</em> |
| <a class="jxr_linenumber" name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * temporary It is not yet persisted and does not have an id yet. After this</em> |
| <a class="jxr_linenumber" name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * call additional actions can take place (like assigning properties and a</em> |
| <a class="jxr_linenumber" name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * type) before it is persisted.</em> |
| <a class="jxr_linenumber" name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * @param name</em> |
| <a class="jxr_linenumber" name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * name of the document</em> |
| <a class="jxr_linenumber" name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * @param propMap</em> |
| <a class="jxr_linenumber" name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * map of properties </em> |
| <a class="jxr_linenumber" name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * @param user</em> |
| <a class="jxr_linenumber" name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * the user who creates the document</em> |
| <a class="jxr_linenumber" name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * @param folder</em> |
| <a class="jxr_linenumber" name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * the parent folder </em> |
| <a class="jxr_linenumber" name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * @param policies</em> |
| <a class="jxr_linenumber" name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * list of policies to apply </em> |
| <a class="jxr_linenumber" name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * @param addACEs</em> |
| <a class="jxr_linenumber" name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * aces that are added </em> |
| <a class="jxr_linenumber" name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * @param removeACEs </em> |
| <a class="jxr_linenumber" name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * aces that are removed</em> |
| <a class="jxr_linenumber" name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * @return document object</em> |
| <a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="101" href="#101">101</a> <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Document.html">Document</a> createDocument(String name, Map<String, PropertyData<?>> propMap, String user, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Folder.html">Folder</a> folder, |
| <a class="jxr_linenumber" name="102" href="#102">102</a> List<String> policies, Acl addACEs, Acl removeACEs); |
| <a class="jxr_linenumber" name="103" href="#103">103</a> |
| <a class="jxr_linenumber" name="104" href="#104">104</a> |
| <a class="jxr_linenumber" name="105" href="#105">105</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * Create a folder as initial step. The folder is created but still</em> |
| <a class="jxr_linenumber" name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * temporary. It is not yet persisted and does not have an id yet. After this</em> |
| <a class="jxr_linenumber" name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * call additional actions can take place (like assigning properties and a</em> |
| <a class="jxr_linenumber" name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * type) before it is persisted.</em> |
| <a class="jxr_linenumber" name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * @param name</em> |
| <a class="jxr_linenumber" name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * name of the folder</em> |
| <a class="jxr_linenumber" name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * @param propMap</em> |
| <a class="jxr_linenumber" name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * map of properties </em> |
| <a class="jxr_linenumber" name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * @param user</em> |
| <a class="jxr_linenumber" name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * the user who creates the document</em> |
| <a class="jxr_linenumber" name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * @param folder</em> |
| <a class="jxr_linenumber" name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * the parent folder </em> |
| <a class="jxr_linenumber" name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * @param policies</em> |
| <a class="jxr_linenumber" name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * list of policies to apply </em> |
| <a class="jxr_linenumber" name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * @param addACEs</em> |
| <a class="jxr_linenumber" name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * aces that are added </em> |
| <a class="jxr_linenumber" name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * @param removeACEs </em> |
| <a class="jxr_linenumber" name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * aces that are removed</em> |
| <a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * @return folder object</em> |
| <a class="jxr_linenumber" name="126" href="#126">126</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="127" href="#127">127</a> <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Folder.html">Folder</a> createFolder(String name, Map<String, PropertyData<?>> propMap, String user, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Folder.html">Folder</a> folder, |
| <a class="jxr_linenumber" name="128" href="#128">128</a> List<String> policies, Acl addACEs, Acl removeACEs); |
| <a class="jxr_linenumber" name="129" href="#129">129</a> |
| <a class="jxr_linenumber" name="130" href="#130">130</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * Create a document that supports versions as initial step. The document is</em> |
| <a class="jxr_linenumber" name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * created but still temporary. It is not yet persisted and does not have an</em> |
| <a class="jxr_linenumber" name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * id yet. After this call additional actions can take place (like assigning</em> |
| <a class="jxr_linenumber" name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * properties and a type) before it is persisted.</em> |
| <a class="jxr_linenumber" name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * @param name</em> |
| <a class="jxr_linenumber" name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * name of the document</em> |
| <a class="jxr_linenumber" name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * * @param propMap</em> |
| <a class="jxr_linenumber" name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * map of properities </em> |
| <a class="jxr_linenumber" name="140" href="#140">140</a> <em class="jxr_javadoccomment"> * @param user</em> |
| <a class="jxr_linenumber" name="141" href="#141">141</a> <em class="jxr_javadoccomment"> * the user who creates the document</em> |
| <a class="jxr_linenumber" name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * @param folder</em> |
| <a class="jxr_linenumber" name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * the parent folder </em> |
| <a class="jxr_linenumber" name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * @param policies</em> |
| <a class="jxr_linenumber" name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * list of policies to apply </em> |
| <a class="jxr_linenumber" name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * @param addACEs</em> |
| <a class="jxr_linenumber" name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * aces that are added </em> |
| <a class="jxr_linenumber" name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * @param removeACEs </em> |
| <a class="jxr_linenumber" name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * aces that are removed</em> |
| <a class="jxr_linenumber" name="150" href="#150">150</a> <em class="jxr_javadoccomment"> * @return versioned document object</em> |
| <a class="jxr_linenumber" name="151" href="#151">151</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="152" href="#152">152</a> <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/DocumentVersion.html">DocumentVersion</a> createVersionedDocument(String name, |
| <a class="jxr_linenumber" name="153" href="#153">153</a> Map<String, PropertyData<?>> propMap, String user, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Folder.html">Folder</a> folder, |
| <a class="jxr_linenumber" name="154" href="#154">154</a> List<String> policies, Acl addACEs, Acl removeACEs, ContentStream contentStream, VersioningState versioningState); |
| <a class="jxr_linenumber" name="155" href="#155">155</a> |
| <a class="jxr_linenumber" name="156" href="#156">156</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="157" href="#157">157</a> <em class="jxr_javadoccomment"> * Create an item as initial step. The item is created but still</em> |
| <a class="jxr_linenumber" name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * temporary. It is not yet persisted and does not have an id yet. After this</em> |
| <a class="jxr_linenumber" name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * call additional actions can take place (like assigning properties and a</em> |
| <a class="jxr_linenumber" name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * type) before it is persisted.</em> |
| <a class="jxr_linenumber" name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * @param name</em> |
| <a class="jxr_linenumber" name="163" href="#163">163</a> <em class="jxr_javadoccomment"> * name of the document</em> |
| <a class="jxr_linenumber" name="164" href="#164">164</a> <em class="jxr_javadoccomment"> * @param propMap</em> |
| <a class="jxr_linenumber" name="165" href="#165">165</a> <em class="jxr_javadoccomment"> * map of properties </em> |
| <a class="jxr_linenumber" name="166" href="#166">166</a> <em class="jxr_javadoccomment"> * @param user</em> |
| <a class="jxr_linenumber" name="167" href="#167">167</a> <em class="jxr_javadoccomment"> * the user who creates the document</em> |
| <a class="jxr_linenumber" name="168" href="#168">168</a> <em class="jxr_javadoccomment"> * @param folder</em> |
| <a class="jxr_linenumber" name="169" href="#169">169</a> <em class="jxr_javadoccomment"> * the parent folder </em> |
| <a class="jxr_linenumber" name="170" href="#170">170</a> <em class="jxr_javadoccomment"> * @param policies</em> |
| <a class="jxr_linenumber" name="171" href="#171">171</a> <em class="jxr_javadoccomment"> * list of policies to apply </em> |
| <a class="jxr_linenumber" name="172" href="#172">172</a> <em class="jxr_javadoccomment"> * @param addACEs</em> |
| <a class="jxr_linenumber" name="173" href="#173">173</a> <em class="jxr_javadoccomment"> * aces that are added </em> |
| <a class="jxr_linenumber" name="174" href="#174">174</a> <em class="jxr_javadoccomment"> * @param removeACEs </em> |
| <a class="jxr_linenumber" name="175" href="#175">175</a> <em class="jxr_javadoccomment"> * aces that are removed</em> |
| <a class="jxr_linenumber" name="176" href="#176">176</a> <em class="jxr_javadoccomment"> * @return document object</em> |
| <a class="jxr_linenumber" name="177" href="#177">177</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="178" href="#178">178</a> <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html">StoredObject</a> createItem(String name, Map<String, PropertyData<?>> propMap, String user, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Folder.html">Folder</a> folder, |
| <a class="jxr_linenumber" name="179" href="#179">179</a> List<String> policies, Acl addACEs, Acl removeACEs); |
| <a class="jxr_linenumber" name="180" href="#180">180</a> |
| <a class="jxr_linenumber" name="181" href="#181">181</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="182" href="#182">182</a> <em class="jxr_javadoccomment"> * Create a policy. The policy is created but still</em> |
| <a class="jxr_linenumber" name="183" href="#183">183</a> <em class="jxr_javadoccomment"> * temporary. It is not yet persisted and does not have an id yet. After this</em> |
| <a class="jxr_linenumber" name="184" href="#184">184</a> <em class="jxr_javadoccomment"> * call additional actions can take place (like assigning properties and a</em> |
| <a class="jxr_linenumber" name="185" href="#185">185</a> <em class="jxr_javadoccomment"> * type) before it is persisted.</em> |
| <a class="jxr_linenumber" name="186" href="#186">186</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="187" href="#187">187</a> <em class="jxr_javadoccomment"> * @param name</em> |
| <a class="jxr_linenumber" name="188" href="#188">188</a> <em class="jxr_javadoccomment"> * name of the document</em> |
| <a class="jxr_linenumber" name="189" href="#189">189</a> <em class="jxr_javadoccomment"> * @param policyText</em> |
| <a class="jxr_linenumber" name="190" href="#190">190</a> <em class="jxr_javadoccomment"> * policy text to apply to this policy </em> |
| <a class="jxr_linenumber" name="191" href="#191">191</a> <em class="jxr_javadoccomment"> * @param propMap</em> |
| <a class="jxr_linenumber" name="192" href="#192">192</a> <em class="jxr_javadoccomment"> * map of properties </em> |
| <a class="jxr_linenumber" name="193" href="#193">193</a> <em class="jxr_javadoccomment"> * @param user</em> |
| <a class="jxr_linenumber" name="194" href="#194">194</a> <em class="jxr_javadoccomment"> * the user who creates the document</em> |
| <a class="jxr_linenumber" name="195" href="#195">195</a> <em class="jxr_javadoccomment"> * @return policy object</em> |
| <a class="jxr_linenumber" name="196" href="#196">196</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="197" href="#197">197</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html">StoredObject</a> createPolicy(String name, String policyText, Map<String, PropertyData<?>> propMap, String user); |
| <a class="jxr_linenumber" name="198" href="#198">198</a> |
| <a class="jxr_linenumber" name="199" href="#199">199</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="200" href="#200">200</a> <em class="jxr_javadoccomment"> * Clear repository and remove all data.</em> |
| <a class="jxr_linenumber" name="201" href="#201">201</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="202" href="#202">202</a> <strong class="jxr_keyword">void</strong> clear(); |
| <a class="jxr_linenumber" name="203" href="#203">203</a> |
| <a class="jxr_linenumber" name="204" href="#204">204</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="205" href="#205">205</a> <em class="jxr_javadoccomment"> * For statistics: return the number of objects contained in the system</em> |
| <a class="jxr_linenumber" name="206" href="#206">206</a> <em class="jxr_javadoccomment"> * @return</em> |
| <a class="jxr_linenumber" name="207" href="#207">207</a> <em class="jxr_javadoccomment"> * number of stored objects</em> |
| <a class="jxr_linenumber" name="208" href="#208">208</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="209" href="#209">209</a> <strong class="jxr_keyword">long</strong> getObjectCount(); |
| <a class="jxr_linenumber" name="210" href="#210">210</a> |
| <a class="jxr_linenumber" name="211" href="#211">211</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="212" href="#212">212</a> <em class="jxr_javadoccomment"> * Create a relationship. The relationship is</em> |
| <a class="jxr_linenumber" name="213" href="#213">213</a> <em class="jxr_javadoccomment"> * created but still temporary. It is not yet persisted and does not have an</em> |
| <a class="jxr_linenumber" name="214" href="#214">214</a> <em class="jxr_javadoccomment"> * id yet. After this call additional actions can take place (like assigning</em> |
| <a class="jxr_linenumber" name="215" href="#215">215</a> <em class="jxr_javadoccomment"> * properties and a type) before it is persisted.</em> |
| <a class="jxr_linenumber" name="216" href="#216">216</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="217" href="#217">217</a> <em class="jxr_javadoccomment"> * @param sourceObject</em> |
| <a class="jxr_linenumber" name="218" href="#218">218</a> <em class="jxr_javadoccomment"> * source of the relationship</em> |
| <a class="jxr_linenumber" name="219" href="#219">219</a> <em class="jxr_javadoccomment"> * @param targetObject</em> |
| <a class="jxr_linenumber" name="220" href="#220">220</a> <em class="jxr_javadoccomment"> * target of the relationship</em> |
| <a class="jxr_linenumber" name="221" href="#221">221</a> <em class="jxr_javadoccomment"> * @param propMap</em> |
| <a class="jxr_linenumber" name="222" href="#222">222</a> <em class="jxr_javadoccomment"> * map of properities </em> |
| <a class="jxr_linenumber" name="223" href="#223">223</a> <em class="jxr_javadoccomment"> * @param user</em> |
| <a class="jxr_linenumber" name="224" href="#224">224</a> <em class="jxr_javadoccomment"> * the user who creates the document</em> |
| <a class="jxr_linenumber" name="225" href="#225">225</a> <em class="jxr_javadoccomment"> * @param folder</em> |
| <a class="jxr_linenumber" name="226" href="#226">226</a> <em class="jxr_javadoccomment"> * the parent folder </em> |
| <a class="jxr_linenumber" name="227" href="#227">227</a> <em class="jxr_javadoccomment"> * @param addACEs</em> |
| <a class="jxr_linenumber" name="228" href="#228">228</a> <em class="jxr_javadoccomment"> * aces that are added </em> |
| <a class="jxr_linenumber" name="229" href="#229">229</a> <em class="jxr_javadoccomment"> * @param removeACEs </em> |
| <a class="jxr_linenumber" name="230" href="#230">230</a> <em class="jxr_javadoccomment"> * aces that are removed</em> |
| <a class="jxr_linenumber" name="231" href="#231">231</a> <em class="jxr_javadoccomment"> * @return versioned document object</em> |
| <a class="jxr_linenumber" name="232" href="#232">232</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="233" href="#233">233</a> <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html">StoredObject</a> createRelationship(String name, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html">StoredObject</a> sourceObject, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html">StoredObject</a> targetObject, |
| <a class="jxr_linenumber" name="234" href="#234">234</a> Map<String, PropertyData<?>> propMap, |
| <a class="jxr_linenumber" name="235" href="#235">235</a> String user, Acl addACEs, Acl removeACEs); |
| <a class="jxr_linenumber" name="236" href="#236">236</a> |
| <a class="jxr_linenumber" name="237" href="#237">237</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="238" href="#238">238</a> <em class="jxr_javadoccomment"> * Return a list of all documents that are checked out in the repository.</em> |
| <a class="jxr_linenumber" name="239" href="#239">239</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="240" href="#240">240</a> <em class="jxr_javadoccomment"> * @param orderBy</em> |
| <a class="jxr_linenumber" name="241" href="#241">241</a> <em class="jxr_javadoccomment"> * orderBy specification according to CMIS spec.</em> |
| <a class="jxr_linenumber" name="242" href="#242">242</a> <em class="jxr_javadoccomment"> * @param user</em> |
| <a class="jxr_linenumber" name="243" href="#243">243</a> <em class="jxr_javadoccomment"> * user id of user calling</em> |
| <a class="jxr_linenumber" name="244" href="#244">244</a> <em class="jxr_javadoccomment"> * @param includeRelationships</em> |
| <a class="jxr_linenumber" name="245" href="#245">245</a> <em class="jxr_javadoccomment"> * if true include all relationships in the response</em> |
| <a class="jxr_linenumber" name="246" href="#246">246</a> <em class="jxr_javadoccomment"> * @return list of checked out documents in the repository</em> |
| <a class="jxr_linenumber" name="247" href="#247">247</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="248" href="#248">248</a> List<StoredObject> getCheckedOutDocuments(String orderBy, String user, IncludeRelationships includeRelationships); |
| <a class="jxr_linenumber" name="249" href="#249">249</a> |
| <a class="jxr_linenumber" name="250" href="#250">250</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="251" href="#251">251</a> <em class="jxr_javadoccomment"> * Apply a ACLs by relative adding and removing a list of ACEs to/from an object</em> |
| <a class="jxr_linenumber" name="252" href="#252">252</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="253" href="#253">253</a> <em class="jxr_javadoccomment"> * @param so</em> |
| <a class="jxr_linenumber" name="254" href="#254">254</a> <em class="jxr_javadoccomment"> * object where ACLs are applied</em> |
| <a class="jxr_linenumber" name="255" href="#255">255</a> <em class="jxr_javadoccomment"> * @param addAces</em> |
| <a class="jxr_linenumber" name="256" href="#256">256</a> <em class="jxr_javadoccomment"> * list of ACEs to be added</em> |
| <a class="jxr_linenumber" name="257" href="#257">257</a> <em class="jxr_javadoccomment"> * @param removeAces</em> |
| <a class="jxr_linenumber" name="258" href="#258">258</a> <em class="jxr_javadoccomment"> * list of ACEs to be removed</em> |
| <a class="jxr_linenumber" name="259" href="#259">259</a> <em class="jxr_javadoccomment"> * @param aclPropagation</em> |
| <a class="jxr_linenumber" name="260" href="#260">260</a> <em class="jxr_javadoccomment"> * enum value how to propagate ACLs to child objects</em> |
| <a class="jxr_linenumber" name="261" href="#261">261</a> <em class="jxr_javadoccomment"> * @return</em> |
| <a class="jxr_linenumber" name="262" href="#262">262</a> <em class="jxr_javadoccomment"> * new ACL of object</em> |
| <a class="jxr_linenumber" name="263" href="#263">263</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="264" href="#264">264</a> Acl applyAcl(<a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html">StoredObject</a> so, Acl addAces, Acl removeAces, AclPropagation aclPropagation, String principalId); |
| <a class="jxr_linenumber" name="265" href="#265">265</a> |
| <a class="jxr_linenumber" name="266" href="#266">266</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="267" href="#267">267</a> <em class="jxr_javadoccomment"> * Apply a ACLs by setting a new list of ACEs to an object</em> |
| <a class="jxr_linenumber" name="268" href="#268">268</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="269" href="#269">269</a> <em class="jxr_javadoccomment"> * @param so</em> |
| <a class="jxr_linenumber" name="270" href="#270">270</a> <em class="jxr_javadoccomment"> * object where ACLs are applied</em> |
| <a class="jxr_linenumber" name="271" href="#271">271</a> <em class="jxr_javadoccomment"> * @param aces</em> |
| <a class="jxr_linenumber" name="272" href="#272">272</a> <em class="jxr_javadoccomment"> * list of ACEs to be applied</em> |
| <a class="jxr_linenumber" name="273" href="#273">273</a> <em class="jxr_javadoccomment"> * @param aclPropagation</em> |
| <a class="jxr_linenumber" name="274" href="#274">274</a> <em class="jxr_javadoccomment"> * enum value how to propagate ACLs to child objects</em> |
| <a class="jxr_linenumber" name="275" href="#275">275</a> <em class="jxr_javadoccomment"> * @return</em> |
| <a class="jxr_linenumber" name="276" href="#276">276</a> <em class="jxr_javadoccomment"> * new ACL of object</em> |
| <a class="jxr_linenumber" name="277" href="#277">277</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="278" href="#278">278</a> Acl applyAcl(<a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/StoredObject.html">StoredObject</a> so, Acl aces, AclPropagation aclPropagation, String principalId); |
| <a class="jxr_linenumber" name="279" href="#279">279</a> |
| <a class="jxr_linenumber" name="280" href="#280">280</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="281" href="#281">281</a> <em class="jxr_javadoccomment"> * Check if this store contains any object with the given type id</em> |
| <a class="jxr_linenumber" name="282" href="#282">282</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="283" href="#283">283</a> <em class="jxr_javadoccomment"> * @param typeId</em> |
| <a class="jxr_linenumber" name="284" href="#284">284</a> <em class="jxr_javadoccomment"> * id of type definition to check</em> |
| <a class="jxr_linenumber" name="285" href="#285">285</a> <em class="jxr_javadoccomment"> * @return</em> |
| <a class="jxr_linenumber" name="286" href="#286">286</a> <em class="jxr_javadoccomment"> * true if at least one object in the store has the given type, false</em> |
| <a class="jxr_linenumber" name="287" href="#287">287</a> <em class="jxr_javadoccomment"> * if no objects exist having this type</em> |
| <a class="jxr_linenumber" name="288" href="#288">288</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="289" href="#289">289</a> <strong class="jxr_keyword">boolean</strong> isTypeInUse(String typeId); |
| <a class="jxr_linenumber" name="290" href="#290">290</a> |
| <a class="jxr_linenumber" name="291" href="#291">291</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="292" href="#292">292</a> <em class="jxr_javadoccomment"> * Get relationships to and from an object</em> |
| <a class="jxr_linenumber" name="293" href="#293">293</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="294" href="#294">294</a> <em class="jxr_javadoccomment"> * @param objectId</em> |
| <a class="jxr_linenumber" name="295" href="#295">295</a> <em class="jxr_javadoccomment"> * id of object to get relationships with</em> |
| <a class="jxr_linenumber" name="296" href="#296">296</a> <em class="jxr_javadoccomment"> * @param subTypeIds</em> |
| <a class="jxr_linenumber" name="297" href="#297">297</a> <em class="jxr_javadoccomment"> * list of all types to be included</em> |
| <a class="jxr_linenumber" name="298" href="#298">298</a> <em class="jxr_javadoccomment"> * @param relationshipDirection</em> |
| <a class="jxr_linenumber" name="299" href="#299">299</a> <em class="jxr_javadoccomment"> * direction of relationship</em> |
| <a class="jxr_linenumber" name="300" href="#300">300</a> <em class="jxr_javadoccomment"> * @return</em> |
| <a class="jxr_linenumber" name="301" href="#301">301</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="302" href="#302">302</a> List<StoredObject> getRelationships(String objectId, List<String> typeIds, |
| <a class="jxr_linenumber" name="303" href="#303">303</a> RelationshipDirection direction); |
| <a class="jxr_linenumber" name="304" href="#304">304</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
