| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_07) on Wed Sep 18 17:57:23 EDT 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>Filing (Apache Chemistry OpenCMIS 0.10.0 API)</title> |
| <meta name="date" content="2013-09-18"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Filing (Apache Chemistry OpenCMIS 0.10.0 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Filing.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Fileable.html" title="interface in org.apache.chemistry.opencmis.inmemory.storedobj.api"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Folder.html" title="interface in org.apache.chemistry.opencmis.inmemory.storedobj.api"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/chemistry/opencmis/inmemory/storedobj/api/Filing.html" target="_top">Frames</a></li> |
| <li><a href="Filing.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.chemistry.opencmis.inmemory.storedobj.api</div> |
| <h2 title="Interface Filing" class="title">Interface Filing</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Document.html" title="interface in org.apache.chemistry.opencmis.inmemory.storedobj.api">Document</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/DocumentVersion.html" title="interface in org.apache.chemistry.opencmis.inmemory.storedobj.api">DocumentVersion</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Fileable.html" title="interface in org.apache.chemistry.opencmis.inmemory.storedobj.api">Fileable</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Folder.html" title="interface in org.apache.chemistry.opencmis.inmemory.storedobj.api">Folder</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Item.html" title="interface in org.apache.chemistry.opencmis.inmemory.storedobj.api">Item</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/MultiFiling.html" title="interface in org.apache.chemistry.opencmis.inmemory.storedobj.api">MultiFiling</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/VersionedDocument.html" title="interface in org.apache.chemistry.opencmis.inmemory.storedobj.api">VersionedDocument</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/impl/DocumentImpl.html" title="class in org.apache.chemistry.opencmis.inmemory.storedobj.impl">DocumentImpl</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/impl/DocumentVersionImpl.html" title="class in org.apache.chemistry.opencmis.inmemory.storedobj.impl">DocumentVersionImpl</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/impl/FilingImpl.html" title="class in org.apache.chemistry.opencmis.inmemory.storedobj.impl">FilingImpl</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/impl/FolderImpl.html" title="class in org.apache.chemistry.opencmis.inmemory.storedobj.impl">FolderImpl</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/impl/ItemImpl.html" title="class in org.apache.chemistry.opencmis.inmemory.storedobj.impl">ItemImpl</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/impl/VersionedDocumentImpl.html" title="class in org.apache.chemistry.opencmis.inmemory.storedobj.impl">VersionedDocumentImpl</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">Filing</span></pre> |
| <div class="block">Path is the capability of an object to get accessed by a path in addition to |
| the identifier. Paths are hierarchical, each object with a path has a parent |
| where the parent is always a folder. Paths do not exist on its own but are |
| part of other objects (documents and folders). Most of the functionality is |
| defined in interfaces that are subclasses.</div> |
| <dl><dt><span class="strong">Author:</span></dt> |
| <dd>Jens</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Filing.html#PATH_SEPARATOR">PATH_SEPARATOR</a></strong></code> |
| <div class="block">character indicating how folders are separated within a path string.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Filing.html#getParentIds()">getParentIds</a></strong>()</code> |
| <div class="block">return a list of parents the principal has access to.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Filing.html#getPathSegment()">getPathSegment</a></strong>()</code> |
| <div class="block">get the path segment of this object</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Filing.html#hasParent()">hasParent</a></strong>()</code> |
| <div class="block">usually true except for the root folder, optimized call that just tests |
| existence to provide information for AtomPub links (much cheaper than |
| calling getParents() and test for empty result.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="PATH_SEPARATOR"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>PATH_SEPARATOR</h4> |
| <pre>static final <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> PATH_SEPARATOR</pre> |
| <div class="block">character indicating how folders are separated within a path string. This |
| char must not be a valid character of an object name.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../constant-values.html#org.apache.chemistry.opencmis.inmemory.storedobj.api.Filing.PATH_SEPARATOR">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getParentIds()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParentIds</h4> |
| <pre><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getParentIds()</pre> |
| <div class="block">return a list of parents the principal has access to. for single parent object this list must contain |
| only one element. returns an empty list if this is an unfiled document.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>user</code> - user id</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>list of parent folders</dd></dl> |
| </li> |
| </ul> |
| <a name="hasParent()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasParent</h4> |
| <pre>boolean hasParent()</pre> |
| <div class="block">usually true except for the root folder, optimized call that just tests |
| existence to provide information for AtomPub links (much cheaper than |
| calling getParents() and test for empty result.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>true if object has a parent, false if it is a root object</dd></dl> |
| </li> |
| </ul> |
| <a name="getPathSegment()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getPathSegment</h4> |
| <pre><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getPathSegment()</pre> |
| <div class="block">get the path segment of this object</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Filing.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Fileable.html" title="interface in org.apache.chemistry.opencmis.inmemory.storedobj.api"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Folder.html" title="interface in org.apache.chemistry.opencmis.inmemory.storedobj.api"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/chemistry/opencmis/inmemory/storedobj/api/Filing.html" target="_top">Frames</a></li> |
| <li><a href="Filing.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2009-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
