Google Git
Sign in
apache / chemistry-site / 19af7d0fa4e1872c926a0e153c3f24d6bc996bae / . / content / java / 1.0.0 / maven / apidocs / org / apache / chemistry / opencmis / client / api / OperationContext.html
blob: 1c097ba5ccd02a086545895468a4518fbebfda41 [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_102) on Fri Sep 02 14:54:45 CEST 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>OperationContext (Apache Chemistry OpenCMIS 1.0.0)</title>
<meta name="date" content="2016-09-02">
<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="OperationContext (Apache Chemistry OpenCMIS 1.0.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":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/OperationContext.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/client/api/ObjectType.html" title="interface in org.apache.chemistry.opencmis.client.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Policy.html" title="interface in org.apache.chemistry.opencmis.client.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/chemistry/opencmis/client/api/OperationContext.html" target="_top">Frames</a></li>
<li><a href="OperationContext.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.client.api</div>
<h2 title="Interface OperationContext" class="title">Interface OperationContext</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">OperationContext</span>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
<div class="block">An <code>OperationContext</code> object defines the filtering, paging and
caching of an operation.</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="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#getCacheKey--">getCacheKey</a></span>()</code>
<div class="block">Returns a key for this OperationContext object that is used for caching.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#getFilter--">getFilter</a></span>()</code>
<div class="block">Returns the current filter.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#getFilterString--">getFilterString</a></span>()</code>
<div class="block">Returns the filter extended by cmis:objectId, cmis:objectTypeId and
cmis:baseTypeId.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/commons/enums/IncludeRelationships.html" title="enum in org.apache.chemistry.opencmis.commons.enums">IncludeRelationships</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#getIncludeRelationships--">getIncludeRelationships</a></span>()</code>
<div class="block">Returns which relationships should be returned.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#getMaxItemsPerPage--">getMaxItemsPerPage</a></span>()</code>
<div class="block">Returns the current max number of items per batch.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#getOrderBy--">getOrderBy</a></span>()</code>
<div class="block">Returns the order by rule for operations that return lists.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#getRenditionFilter--">getRenditionFilter</a></span>()</code>
<div class="block">Returns the current rendition filter.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#getRenditionFilterString--">getRenditionFilterString</a></span>()</code>
<div class="block">Returns the current rendition filter.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#isCacheEnabled--">isCacheEnabled</a></span>()</code>
<div class="block">Return if caching is enabled.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#isIncludeAcls--">isIncludeAcls</a></span>()</code>
<div class="block">Returns if ACLs should returned.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#isIncludeAllowableActions--">isIncludeAllowableActions</a></span>()</code>
<div class="block">Returns if allowable actions should returned.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#isIncludePathSegments--">isIncludePathSegments</a></span>()</code>
<div class="block">Returns if path segments should returned.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#isIncludePolicies--">isIncludePolicies</a></span>()</code>
<div class="block">Returns if policies should returned.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#loadSecondaryTypeProperties--">loadSecondaryTypeProperties</a></span>()</code>
<div class="block">Returns is secondary type properties should be loaded.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setCacheEnabled-boolean-">setCacheEnabled</a></span>(boolean&nbsp;cacheEnabled)</code>
<div class="block">Enables or disables the cache.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setFilter-java.util.Set-">setFilter</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;propertyFilter)</code>
<div class="block">Sets the current filter.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setFilterString-java.lang.String-">setFilterString</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;propertyFilter)</code>
<div class="block">Sets the current filter.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setIncludeAcls-boolean-">setIncludeAcls</a></span>(boolean&nbsp;include)</code>
<div class="block">Sets if ACLs should returned.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setIncludeAllowableActions-boolean-">setIncludeAllowableActions</a></span>(boolean&nbsp;include)</code>
<div class="block">Sets if allowable actions should returned.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setIncludePathSegments-boolean-">setIncludePathSegments</a></span>(boolean&nbsp;include)</code>
<div class="block">Sets if path segments should returned.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setIncludePolicies-boolean-">setIncludePolicies</a></span>(boolean&nbsp;include)</code>
<div class="block">Sets if policies should returned.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setIncludeRelationships-org.apache.chemistry.opencmis.commons.enums.IncludeRelationships-">setIncludeRelationships</a></span>(<a href="../../../../../../org/apache/chemistry/opencmis/commons/enums/IncludeRelationships.html" title="enum in org.apache.chemistry.opencmis.commons.enums">IncludeRelationships</a>&nbsp;include)</code>
<div class="block">Sets which relationships should be returned.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setLoadSecondaryTypeProperties-boolean-">setLoadSecondaryTypeProperties</a></span>(boolean&nbsp;load)</code>
<div class="block">Sets if secondary type properties should be loaded.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setMaxItemsPerPage-int-">setMaxItemsPerPage</a></span>(int&nbsp;maxItemsPerPage)</code>
<div class="block">Set the max number of items per batch for operations that return lists.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setOrderBy-java.lang.String-">setOrderBy</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;orderBy)</code>
<div class="block">Sets the order by rule for operations that return lists.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setRenditionFilter-java.util.Set-">setRenditionFilter</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;renditionFilter)</code>
<div class="block">Sets the current rendition filter.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setRenditionFilterString-java.lang.String-">setRenditionFilterString</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;renditionFilter)</code>
<div class="block">Sets the current rendition filter.</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="getFilter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilter</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;getFilter()</pre>
<div class="block">Returns the current filter.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a set of <em>query names</em></dd>
</dl>
</li>
</ul>
<a name="setFilter-java.util.Set-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFilter</h4>
<pre>void&nbsp;setFilter(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;propertyFilter)</pre>
<div class="block">Sets the current filter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>propertyFilter</code> - a set of <em>query names</em></dd>
</dl>
</li>
</ul>
<a name="setFilterString-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFilterString</h4>
<pre>void&nbsp;setFilterString(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;propertyFilter)</pre>
<div class="block">Sets the current filter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>propertyFilter</code> - a comma separated string of <em>query names</em> or "*" for
all properties or <code>null</code> to let the repository determine
a set of properties</dd>
</dl>
</li>
</ul>
<a name="getFilterString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilterString</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getFilterString()</pre>
<div class="block">Returns the filter extended by cmis:objectId, cmis:objectTypeId and
cmis:baseTypeId.</div>
</li>
</ul>
<a name="setLoadSecondaryTypeProperties-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLoadSecondaryTypeProperties</h4>
<pre>void&nbsp;setLoadSecondaryTypeProperties(boolean&nbsp;load)</pre>
<div class="block">Sets if secondary type properties should be loaded.</div>
<dl>
<dt><span class="simpleTagLabel">CMIS:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a name="loadSecondaryTypeProperties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadSecondaryTypeProperties</h4>
<pre>boolean&nbsp;loadSecondaryTypeProperties()</pre>
<div class="block">Returns is secondary type properties should be loaded.</div>
<dl>
<dt><span class="simpleTagLabel">CMIS:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a name="isIncludeAllowableActions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isIncludeAllowableActions</h4>
<pre>boolean&nbsp;isIncludeAllowableActions()</pre>
<div class="block">Returns if allowable actions should returned.</div>
</li>
</ul>
<a name="setIncludeAllowableActions-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIncludeAllowableActions</h4>
<pre>void&nbsp;setIncludeAllowableActions(boolean&nbsp;include)</pre>
<div class="block">Sets if allowable actions should returned.</div>
</li>
</ul>
<a name="isIncludeAcls--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isIncludeAcls</h4>
<pre>boolean&nbsp;isIncludeAcls()</pre>
<div class="block">Returns if ACLs should returned.</div>
</li>
</ul>
<a name="setIncludeAcls-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIncludeAcls</h4>
<pre>void&nbsp;setIncludeAcls(boolean&nbsp;include)</pre>
<div class="block">Sets if ACLs should returned.</div>
</li>
</ul>
<a name="getIncludeRelationships--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIncludeRelationships</h4>
<pre><a href="../../../../../../org/apache/chemistry/opencmis/commons/enums/IncludeRelationships.html" title="enum in org.apache.chemistry.opencmis.commons.enums">IncludeRelationships</a>&nbsp;getIncludeRelationships()</pre>
<div class="block">Returns which relationships should be returned.</div>
</li>
</ul>
<a name="setIncludeRelationships-org.apache.chemistry.opencmis.commons.enums.IncludeRelationships-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIncludeRelationships</h4>
<pre>void&nbsp;setIncludeRelationships(<a href="../../../../../../org/apache/chemistry/opencmis/commons/enums/IncludeRelationships.html" title="enum in org.apache.chemistry.opencmis.commons.enums">IncludeRelationships</a>&nbsp;include)</pre>
<div class="block">Sets which relationships should be returned.</div>
</li>
</ul>
<a name="isIncludePolicies--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isIncludePolicies</h4>
<pre>boolean&nbsp;isIncludePolicies()</pre>
<div class="block">Returns if policies should returned.</div>
</li>
</ul>
<a name="setIncludePolicies-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIncludePolicies</h4>
<pre>void&nbsp;setIncludePolicies(boolean&nbsp;include)</pre>
<div class="block">Sets if policies should returned.</div>
</li>
</ul>
<a name="getRenditionFilter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRenditionFilter</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;getRenditionFilter()</pre>
<div class="block">Returns the current rendition filter. (See CMIS spec
"2.2.1.2.4.1 Rendition Filter Grammar")</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a set of rendition filter terms</dd>
</dl>
</li>
</ul>
<a name="setRenditionFilter-java.util.Set-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRenditionFilter</h4>
<pre>void&nbsp;setRenditionFilter(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;renditionFilter)</pre>
<div class="block">Sets the current rendition filter. (See CMIS spec
"2.2.1.2.4.1 Rendition Filter Grammar")</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>renditionFilter</code> - a set of rendition filter terms</dd>
</dl>
</li>
</ul>
<a name="setRenditionFilterString-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRenditionFilterString</h4>
<pre>void&nbsp;setRenditionFilterString(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;renditionFilter)</pre>
<div class="block">Sets the current rendition filter. (See CMIS spec
"2.2.1.2.4.1 Rendition Filter Grammar")</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>renditionFilter</code> - a comma separated list of rendition filter terms</dd>
</dl>
</li>
</ul>
<a name="getRenditionFilterString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRenditionFilterString</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getRenditionFilterString()</pre>
<div class="block">Returns the current rendition filter. (See CMIS spec
"2.2.1.2.4.1 Rendition Filter Grammar")</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a comma separated list of rendition filter terms</dd>
</dl>
</li>
</ul>
<a name="isIncludePathSegments--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isIncludePathSegments</h4>
<pre>boolean&nbsp;isIncludePathSegments()</pre>
<div class="block">Returns if path segments should returned.</div>
</li>
</ul>
<a name="setIncludePathSegments-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIncludePathSegments</h4>
<pre>void&nbsp;setIncludePathSegments(boolean&nbsp;include)</pre>
<div class="block">Sets if path segments should returned.</div>
</li>
</ul>
<a name="getOrderBy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOrderBy</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getOrderBy()</pre>
<div class="block">Returns the order by rule for operations that return lists.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a comma-separated list of <em>query names</em> and the ascending
modifier "ASC" or the descending modifier "DESC" for each query
name</dd>
</dl>
</li>
</ul>
<a name="setOrderBy-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOrderBy</h4>
<pre>void&nbsp;setOrderBy(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;orderBy)</pre>
<div class="block">Sets the order by rule for operations that return lists.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>orderBy</code> - a comma-separated list of <em>query names</em> and the
ascending modifier "ASC" or the descending modifier "DESC" for
each query name</dd>
</dl>
</li>
</ul>
<a name="isCacheEnabled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCacheEnabled</h4>
<pre>boolean&nbsp;isCacheEnabled()</pre>
<div class="block">Return if caching is enabled.</div>
</li>
</ul>
<a name="setCacheEnabled-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCacheEnabled</h4>
<pre>void&nbsp;setCacheEnabled(boolean&nbsp;cacheEnabled)</pre>
<div class="block">Enables or disables the cache.</div>
</li>
</ul>
<a name="getCacheKey--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheKey</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getCacheKey()</pre>
<div class="block">Returns a key for this OperationContext object that is used for caching.</div>
</li>
</ul>
<a name="setMaxItemsPerPage-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxItemsPerPage</h4>
<pre>void&nbsp;setMaxItemsPerPage(int&nbsp;maxItemsPerPage)</pre>
<div class="block">Set the max number of items per batch for operations that return lists.
This option does not restrict the number of returned items. To retrieve
an excerpt (page) of a list, see <a href="../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html#getPage-int-"><code>ItemIterable.getPage(int)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxItemsPerPage</code> - max number of items (must be positive)</dd>
</dl>
</li>
</ul>
<a name="getMaxItemsPerPage--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getMaxItemsPerPage</h4>
<pre>int&nbsp;getMaxItemsPerPage()</pre>
<div class="block">Returns the current max number of items per batch.</div>
</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/OperationContext.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/client/api/ObjectType.html" title="interface in org.apache.chemistry.opencmis.client.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Policy.html" title="interface in org.apache.chemistry.opencmis.client.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/chemistry/opencmis/client/api/OperationContext.html" target="_top">Frames</a></li>
<li><a href="OperationContext.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>