blob: 5609059937b538401a7b6706af6413b7328c97e8 [file] [log] [blame]
<!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 (1.8.0_91) on Sat Jun 04 15:52:17 CEST 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>NavigationService (Apache Chemistry OpenCMIS 0.14.0)</title>
<meta name="date" content="2016-06-04">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="NavigationService (Apache Chemistry OpenCMIS 0.14.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/NavigationService.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/commons/spi/MultiFilingService.html" title="interface in org.apache.chemistry.opencmis.commons.spi"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/ObjectService.html" title="interface in org.apache.chemistry.opencmis.commons.spi"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/chemistry/opencmis/commons/spi/NavigationService.html" target="_top">Frames</a></li>
<li><a href="NavigationService.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.commons.spi</div>
<h2 title="Interface NavigationService" class="title">Interface NavigationService</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/server/support/wrapper/CallContextAwareCmisService.html" title="interface in org.apache.chemistry.opencmis.server.support.wrapper">CallContextAwareCmisService</a>, <a href="../../../../../../org/apache/chemistry/opencmis/commons/server/CmisService.html" title="interface in org.apache.chemistry.opencmis.commons.server">CmisService</a>, <a href="../../../../../../org/apache/chemistry/opencmis/commons/server/ProgressControlCmisService.html" title="interface in org.apache.chemistry.opencmis.commons.server">ProgressControlCmisService</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/chemistry/opencmis/server/support/wrapper/AbstractBindingCmisServiceWrapper.html" title="class in org.apache.chemistry.opencmis.server.support.wrapper">AbstractBindingCmisServiceWrapper</a>, <a href="../../../../../../org/apache/chemistry/opencmis/commons/impl/server/AbstractCmisService.html" title="class in org.apache.chemistry.opencmis.commons.impl.server">AbstractCmisService</a>, <a href="../../../../../../org/apache/chemistry/opencmis/server/support/wrapper/AbstractCmisServiceWrapper.html" title="class in org.apache.chemistry.opencmis.server.support.wrapper">AbstractCmisServiceWrapper</a>, <a href="../../../../../../org/apache/chemistry/opencmis/bridge/CachedBindingCmisService.html" title="class in org.apache.chemistry.opencmis.bridge">CachedBindingCmisService</a>, <a href="../../../../../../org/apache/chemistry/opencmis/server/support/CmisServiceWrapper.html" title="class in org.apache.chemistry.opencmis.server.support">CmisServiceWrapper</a>, <a href="../../../../../../org/apache/chemistry/opencmis/server/support/wrapper/ConformanceCmisServiceWrapper.html" title="class in org.apache.chemistry.opencmis.server.support.wrapper">ConformanceCmisServiceWrapper</a>, <a href="../../../../../../org/apache/chemistry/opencmis/bridge/FilterCmisService.html" title="class in org.apache.chemistry.opencmis.bridge">FilterCmisService</a>, <a href="../../../../../../org/apache/chemistry/opencmis/bridge/httpsession/HttpSessionCmisService.html" title="class in org.apache.chemistry.opencmis.bridge.httpsession">HttpSessionCmisService</a>, <a href="../../../../../../org/apache/chemistry/opencmis/bridge/lrucache/LruCacheCmisService.html" title="class in org.apache.chemistry.opencmis.bridge.lrucache">LruCacheCmisService</a>, <a href="../../../../../../org/apache/chemistry/opencmis/bridge/httpsession/sample/SimpleForwardingCmisService.html" title="class in org.apache.chemistry.opencmis.bridge.httpsession.sample">SimpleForwardingCmisService</a>, <a href="../../../../../../org/apache/chemistry/opencmis/server/support/wrapper/SimpleLoggingCmisServiceWrapper.html" title="class in org.apache.chemistry.opencmis.server.support.wrapper">SimpleLoggingCmisServiceWrapper</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">NavigationService</span></pre>
<div class="block">Navigation Service interface.
<p>
<em>
See the CMIS 1.0 and CMIS 1.1 specifications for details on the operations, parameters,
exceptions and the domain model.
</em>
</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ObjectList.html" title="interface in org.apache.chemistry.opencmis.commons.data">ObjectList</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/NavigationService.html#getCheckedOutDocs-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.Boolean-org.apache.chemistry.opencmis.commons.enums.IncludeRelationships-java.lang.String-java.math.BigInteger-java.math.BigInteger-org.apache.chemistry.opencmis.commons.data.ExtensionsData-">getCheckedOutDocs</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;repositoryId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;folderId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;filter,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;orderBy,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;includeAllowableActions,
<a href="../../../../../../org/apache/chemistry/opencmis/commons/enums/IncludeRelationships.html" title="enum in org.apache.chemistry.opencmis.commons.enums">IncludeRelationships</a>&nbsp;includeRelationships,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;renditionFilter,
<a href="http://docs.oracle.com/javase/6/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a>&nbsp;maxItems,
<a href="http://docs.oracle.com/javase/6/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a>&nbsp;skipCount,
<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ExtensionsData.html" title="interface in org.apache.chemistry.opencmis.commons.data">ExtensionsData</a>&nbsp;extension)</code>
<div class="block">Gets the list of documents that are checked out that the user has access
to.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ObjectInFolderList.html" title="interface in org.apache.chemistry.opencmis.commons.data">ObjectInFolderList</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/NavigationService.html#getChildren-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.Boolean-org.apache.chemistry.opencmis.commons.enums.IncludeRelationships-java.lang.String-java.lang.Boolean-java.math.BigInteger-java.math.BigInteger-org.apache.chemistry.opencmis.commons.data.ExtensionsData-">getChildren</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;repositoryId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;folderId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;filter,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;orderBy,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;includeAllowableActions,
<a href="../../../../../../org/apache/chemistry/opencmis/commons/enums/IncludeRelationships.html" title="enum in org.apache.chemistry.opencmis.commons.enums">IncludeRelationships</a>&nbsp;includeRelationships,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;renditionFilter,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;includePathSegment,
<a href="http://docs.oracle.com/javase/6/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a>&nbsp;maxItems,
<a href="http://docs.oracle.com/javase/6/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a>&nbsp;skipCount,
<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ExtensionsData.html" title="interface in org.apache.chemistry.opencmis.commons.data">ExtensionsData</a>&nbsp;extension)</code>
<div class="block">Gets the list of child objects contained in the specified folder.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ObjectInFolderContainer.html" title="interface in org.apache.chemistry.opencmis.commons.data">ObjectInFolderContainer</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/NavigationService.html#getDescendants-java.lang.String-java.lang.String-java.math.BigInteger-java.lang.String-java.lang.Boolean-org.apache.chemistry.opencmis.commons.enums.IncludeRelationships-java.lang.String-java.lang.Boolean-org.apache.chemistry.opencmis.commons.data.ExtensionsData-">getDescendants</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;repositoryId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;folderId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a>&nbsp;depth,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;filter,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;includeAllowableActions,
<a href="../../../../../../org/apache/chemistry/opencmis/commons/enums/IncludeRelationships.html" title="enum in org.apache.chemistry.opencmis.commons.enums">IncludeRelationships</a>&nbsp;includeRelationships,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;renditionFilter,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;includePathSegment,
<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ExtensionsData.html" title="interface in org.apache.chemistry.opencmis.commons.data">ExtensionsData</a>&nbsp;extension)</code>
<div class="block">Gets the set of descendant objects contained in the specified folder or
any of its child folders.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ObjectData.html" title="interface in org.apache.chemistry.opencmis.commons.data">ObjectData</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/NavigationService.html#getFolderParent-java.lang.String-java.lang.String-java.lang.String-org.apache.chemistry.opencmis.commons.data.ExtensionsData-">getFolderParent</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;repositoryId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;folderId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;filter,
<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ExtensionsData.html" title="interface in org.apache.chemistry.opencmis.commons.data">ExtensionsData</a>&nbsp;extension)</code>
<div class="block">Gets the parent folder object for the specified folder object.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ObjectInFolderContainer.html" title="interface in org.apache.chemistry.opencmis.commons.data">ObjectInFolderContainer</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/NavigationService.html#getFolderTree-java.lang.String-java.lang.String-java.math.BigInteger-java.lang.String-java.lang.Boolean-org.apache.chemistry.opencmis.commons.enums.IncludeRelationships-java.lang.String-java.lang.Boolean-org.apache.chemistry.opencmis.commons.data.ExtensionsData-">getFolderTree</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;repositoryId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;folderId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a>&nbsp;depth,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;filter,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;includeAllowableActions,
<a href="../../../../../../org/apache/chemistry/opencmis/commons/enums/IncludeRelationships.html" title="enum in org.apache.chemistry.opencmis.commons.enums">IncludeRelationships</a>&nbsp;includeRelationships,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;renditionFilter,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;includePathSegment,
<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ExtensionsData.html" title="interface in org.apache.chemistry.opencmis.commons.data">ExtensionsData</a>&nbsp;extension)</code>
<div class="block">Gets the set of descendant folder objects contained in the specified
folder.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ObjectParentData.html" title="interface in org.apache.chemistry.opencmis.commons.data">ObjectParentData</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/NavigationService.html#getObjectParents-java.lang.String-java.lang.String-java.lang.String-java.lang.Boolean-org.apache.chemistry.opencmis.commons.enums.IncludeRelationships-java.lang.String-java.lang.Boolean-org.apache.chemistry.opencmis.commons.data.ExtensionsData-">getObjectParents</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;repositoryId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;objectId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;filter,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;includeAllowableActions,
<a href="../../../../../../org/apache/chemistry/opencmis/commons/enums/IncludeRelationships.html" title="enum in org.apache.chemistry.opencmis.commons.enums">IncludeRelationships</a>&nbsp;includeRelationships,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;renditionFilter,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;includeRelativePathSegment,
<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ExtensionsData.html" title="interface in org.apache.chemistry.opencmis.commons.data">ExtensionsData</a>&nbsp;extension)</code>
<div class="block">Gets the parent folder(s) for the specified non-folder, fileable object.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getChildren-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.Boolean-org.apache.chemistry.opencmis.commons.enums.IncludeRelationships-java.lang.String-java.lang.Boolean-java.math.BigInteger-java.math.BigInteger-org.apache.chemistry.opencmis.commons.data.ExtensionsData-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChildren</h4>
<pre><a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ObjectInFolderList.html" title="interface in org.apache.chemistry.opencmis.commons.data">ObjectInFolderList</a>&nbsp;getChildren(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;repositoryId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;folderId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;filter,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;orderBy,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;includeAllowableActions,
<a href="../../../../../../org/apache/chemistry/opencmis/commons/enums/IncludeRelationships.html" title="enum in org.apache.chemistry.opencmis.commons.enums">IncludeRelationships</a>&nbsp;includeRelationships,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;renditionFilter,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;includePathSegment,
<a href="http://docs.oracle.com/javase/6/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a>&nbsp;maxItems,
<a href="http://docs.oracle.com/javase/6/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a>&nbsp;skipCount,
<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ExtensionsData.html" title="interface in org.apache.chemistry.opencmis.commons.data">ExtensionsData</a>&nbsp;extension)</pre>
<div class="block">Gets the list of child objects contained in the specified folder.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>repositoryId</code> - the identifier for the repository</dd>
<dd><code>folderId</code> - the identifier for the folder</dd>
<dd><code>filter</code> - <em>(optional)</em> a comma-separated list of query names that
defines which properties must be returned by the repository
(default is repository specific)</dd>
<dd><code>orderBy</code> - <em>(optional)</em> a comma-separated list of query names that
define the order of the result set. Each query name must be
followed by the ascending modifier "ASC" or the descending
modifier "DESC" (default is repository specific)</dd>
<dd><code>includeAllowableActions</code> - <em>(optional)</em> if <code>true</code>, then the repository must
return the available actions for each object in the result set
(default is <code>false</code>)</dd>
<dd><code>includeRelationships</code> - <em>(optional)</em> indicates what relationships in which the
objects participate must be returned (default is
<a href="../../../../../../org/apache/chemistry/opencmis/commons/enums/IncludeRelationships.html#NONE"><code>IncludeRelationships.NONE</code></a>)</dd>
<dd><code>renditionFilter</code> - <em>(optional)</em> indicates what set of renditions the
repository must return whose kind matches this filter (default
is <code>"cmis:none"</code>)</dd>
<dd><code>includePathSegment</code> - <em>(optional)</em> if <code>true</code>, returns a path segment
for each child object for use in constructing that object's
path (default is <code>false</code>)</dd>
<dd><code>maxItems</code> - <em>(optional)</em> the maximum number of items to return in a
response (default is repository specific)</dd>
<dd><code>skipCount</code> - <em>(optional)</em> number of potential results that the
repository MUST skip/page over before returning any results
(default is 0)</dd>
<dd><code>extension</code> - extension data</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of children</dd>
</dl>
</li>
</ul>
<a name="getDescendants-java.lang.String-java.lang.String-java.math.BigInteger-java.lang.String-java.lang.Boolean-org.apache.chemistry.opencmis.commons.enums.IncludeRelationships-java.lang.String-java.lang.Boolean-org.apache.chemistry.opencmis.commons.data.ExtensionsData-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescendants</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ObjectInFolderContainer.html" title="interface in org.apache.chemistry.opencmis.commons.data">ObjectInFolderContainer</a>&gt;&nbsp;getDescendants(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;repositoryId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;folderId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a>&nbsp;depth,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;filter,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;includeAllowableActions,
<a href="../../../../../../org/apache/chemistry/opencmis/commons/enums/IncludeRelationships.html" title="enum in org.apache.chemistry.opencmis.commons.enums">IncludeRelationships</a>&nbsp;includeRelationships,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;renditionFilter,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;includePathSegment,
<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ExtensionsData.html" title="interface in org.apache.chemistry.opencmis.commons.data">ExtensionsData</a>&nbsp;extension)</pre>
<div class="block">Gets the set of descendant objects contained in the specified folder or
any of its child folders.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>repositoryId</code> - the identifier for the repository</dd>
<dd><code>folderId</code> - the identifier for the folder</dd>
<dd><code>depth</code> - the number of levels of depth in the folder hierarchy from
which to return results</dd>
<dd><code>filter</code> - <em>(optional)</em> a comma-separated list of query names that
defines which properties must be returned by the repository
(default is repository specific)</dd>
<dd><code>includeAllowableActions</code> - <em>(optional)</em> if <code>true</code>, then the repository must
return the available actions for each object in the result set
(default is <code>false</code>)</dd>
<dd><code>includeRelationships</code> - <em>(optional)</em> indicates what relationships in which the
objects participate must be returned (default is
<a href="../../../../../../org/apache/chemistry/opencmis/commons/enums/IncludeRelationships.html#NONE"><code>IncludeRelationships.NONE</code></a>)</dd>
<dd><code>renditionFilter</code> - <em>(optional)</em> indicates what set of renditions the
repository must return whose kind matches this filter (default
is <code>"cmis:none"</code>)</dd>
<dd><code>includePathSegment</code> - <em>(optional)</em> if <code>true</code>, returns a path segment
for each child object for use in constructing that object's
path (default is <code>false</code>)</dd>
<dd><code>extension</code> - extension data</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the tree of descendants</dd>
</dl>
</li>
</ul>
<a name="getFolderTree-java.lang.String-java.lang.String-java.math.BigInteger-java.lang.String-java.lang.Boolean-org.apache.chemistry.opencmis.commons.enums.IncludeRelationships-java.lang.String-java.lang.Boolean-org.apache.chemistry.opencmis.commons.data.ExtensionsData-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFolderTree</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ObjectInFolderContainer.html" title="interface in org.apache.chemistry.opencmis.commons.data">ObjectInFolderContainer</a>&gt;&nbsp;getFolderTree(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;repositoryId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;folderId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a>&nbsp;depth,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;filter,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;includeAllowableActions,
<a href="../../../../../../org/apache/chemistry/opencmis/commons/enums/IncludeRelationships.html" title="enum in org.apache.chemistry.opencmis.commons.enums">IncludeRelationships</a>&nbsp;includeRelationships,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;renditionFilter,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;includePathSegment,
<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ExtensionsData.html" title="interface in org.apache.chemistry.opencmis.commons.data">ExtensionsData</a>&nbsp;extension)</pre>
<div class="block">Gets the set of descendant folder objects contained in the specified
folder.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>repositoryId</code> - the identifier for the repository</dd>
<dd><code>folderId</code> - the identifier for the folder</dd>
<dd><code>depth</code> - the number of levels of depth in the folder hierarchy from
which to return results</dd>
<dd><code>filter</code> - <em>(optional)</em> a comma-separated list of query names that
defines which properties must be returned by the repository
(default is repository specific)</dd>
<dd><code>includeAllowableActions</code> - <em>(optional)</em> if <code>true</code>, then the repository must
return the available actions for each object in the result set
(default is <code>false</code>)</dd>
<dd><code>includeRelationships</code> - <em>(optional)</em> indicates what relationships in which the
objects participate must be returned (default is
<a href="../../../../../../org/apache/chemistry/opencmis/commons/enums/IncludeRelationships.html#NONE"><code>IncludeRelationships.NONE</code></a>)</dd>
<dd><code>renditionFilter</code> - <em>(optional)</em> indicates what set of renditions the
repository must return whose kind matches this filter (default
is <code>"cmis:none"</code>)</dd>
<dd><code>includePathSegment</code> - <em>(optional)</em> if <code>true</code>, returns a path segment
for each child object for use in constructing that object's
path (default is <code>false</code>)</dd>
<dd><code>extension</code> - extension data</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the folder tree</dd>
</dl>
</li>
</ul>
<a name="getObjectParents-java.lang.String-java.lang.String-java.lang.String-java.lang.Boolean-org.apache.chemistry.opencmis.commons.enums.IncludeRelationships-java.lang.String-java.lang.Boolean-org.apache.chemistry.opencmis.commons.data.ExtensionsData-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getObjectParents</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ObjectParentData.html" title="interface in org.apache.chemistry.opencmis.commons.data">ObjectParentData</a>&gt;&nbsp;getObjectParents(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;repositoryId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;objectId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;filter,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;includeAllowableActions,
<a href="../../../../../../org/apache/chemistry/opencmis/commons/enums/IncludeRelationships.html" title="enum in org.apache.chemistry.opencmis.commons.enums">IncludeRelationships</a>&nbsp;includeRelationships,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;renditionFilter,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;includeRelativePathSegment,
<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ExtensionsData.html" title="interface in org.apache.chemistry.opencmis.commons.data">ExtensionsData</a>&nbsp;extension)</pre>
<div class="block">Gets the parent folder(s) for the specified non-folder, fileable object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>repositoryId</code> - the identifier for the repository</dd>
<dd><code>objectId</code> - the identifier for the object</dd>
<dd><code>filter</code> - <em>(optional)</em> a comma-separated list of query names that
defines which properties must be returned by the repository
(default is repository specific)</dd>
<dd><code>includeAllowableActions</code> - <em>(optional)</em> if <code>true</code>, then the repository must
return the available actions for each object in the result set
(default is <code>false</code>)</dd>
<dd><code>includeRelationships</code> - <em>(optional)</em> indicates what relationships in which the
objects participate must be returned (default is
<a href="../../../../../../org/apache/chemistry/opencmis/commons/enums/IncludeRelationships.html#NONE"><code>IncludeRelationships.NONE</code></a>)</dd>
<dd><code>renditionFilter</code> - <em>(optional)</em> indicates what set of renditions the
repository must return whose kind matches this filter (default
is <code>"cmis:none"</code>)</dd>
<dd><code>includeRelativePathSegment</code> - <em>(optional)</em> if <code>true</code>, returns a relative path
segment for each parent object for use in constructing that
object's path (default is <code>false</code>)</dd>
<dd><code>extension</code> - extension data</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of parents</dd>
</dl>
</li>
</ul>
<a name="getFolderParent-java.lang.String-java.lang.String-java.lang.String-org.apache.chemistry.opencmis.commons.data.ExtensionsData-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFolderParent</h4>
<pre><a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ObjectData.html" title="interface in org.apache.chemistry.opencmis.commons.data">ObjectData</a>&nbsp;getFolderParent(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;repositoryId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;folderId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;filter,
<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ExtensionsData.html" title="interface in org.apache.chemistry.opencmis.commons.data">ExtensionsData</a>&nbsp;extension)</pre>
<div class="block">Gets the parent folder object for the specified folder object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>repositoryId</code> - the identifier for the repository</dd>
<dd><code>folderId</code> - the identifier for the folder</dd>
<dd><code>filter</code> - <em>(optional)</em> a comma-separated list of query names that
defines which properties must be returned by the repository
(default is repository specific)</dd>
<dd><code>extension</code> - extension data</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the folder parent</dd>
</dl>
</li>
</ul>
<a name="getCheckedOutDocs-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.Boolean-org.apache.chemistry.opencmis.commons.enums.IncludeRelationships-java.lang.String-java.math.BigInteger-java.math.BigInteger-org.apache.chemistry.opencmis.commons.data.ExtensionsData-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCheckedOutDocs</h4>
<pre><a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ObjectList.html" title="interface in org.apache.chemistry.opencmis.commons.data">ObjectList</a>&nbsp;getCheckedOutDocs(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;repositoryId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;folderId,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;filter,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;orderBy,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;includeAllowableActions,
<a href="../../../../../../org/apache/chemistry/opencmis/commons/enums/IncludeRelationships.html" title="enum in org.apache.chemistry.opencmis.commons.enums">IncludeRelationships</a>&nbsp;includeRelationships,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;renditionFilter,
<a href="http://docs.oracle.com/javase/6/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a>&nbsp;maxItems,
<a href="http://docs.oracle.com/javase/6/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a>&nbsp;skipCount,
<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ExtensionsData.html" title="interface in org.apache.chemistry.opencmis.commons.data">ExtensionsData</a>&nbsp;extension)</pre>
<div class="block">Gets the list of documents that are checked out that the user has access
to.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>repositoryId</code> - the identifier for the repository</dd>
<dd><code>folderId</code> - the identifier for the folder</dd>
<dd><code>filter</code> - <em>(optional)</em> a comma-separated list of query names that
defines which properties must be returned by the repository
(default is repository specific)</dd>
<dd><code>orderBy</code> - <em>(optional)</em> a comma-separated list of query names that
define the order of the result set. Each query name must be
followed by the ascending modifier "ASC" or the descending
modifier "DESC" (default is repository specific)</dd>
<dd><code>includeAllowableActions</code> - <em>(optional)</em> if <code>true</code>, then the repository must
return the available actions for each object in the result set
(default is <code>false</code>)</dd>
<dd><code>includeRelationships</code> - <em>(optional)</em> indicates what relationships in which the
objects participate must be returned (default is
<a href="../../../../../../org/apache/chemistry/opencmis/commons/enums/IncludeRelationships.html#NONE"><code>IncludeRelationships.NONE</code></a>)</dd>
<dd><code>renditionFilter</code> - <em>(optional)</em> indicates what set of renditions the
repository must return whose kind matches this filter (default
is <code>"cmis:none"</code>)</dd>
<dd><code>maxItems</code> - <em>(optional)</em> the maximum number of items to return in a
response (default is repository specific)</dd>
<dd><code>skipCount</code> - <em>(optional)</em> number of potential results that the
repository MUST skip/page over before returning any results
(default is 0)</dd>
<dd><code>extension</code> - extension data</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of checked out documents</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/NavigationService.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/commons/spi/MultiFilingService.html" title="interface in org.apache.chemistry.opencmis.commons.spi"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/chemistry/opencmis/commons/spi/ObjectService.html" title="interface in org.apache.chemistry.opencmis.commons.spi"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/chemistry/opencmis/commons/spi/NavigationService.html" target="_top">Frames</a></li>
<li><a href="NavigationService.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2009&#x2013;2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>