Google Git
Sign in
apache / chemistry-site / 19af7d0fa4e1872c926a0e153c3f24d6bc996bae / . / content / java / 0.10.0 / maven / apidocs / org / apache / chemistry / opencmis / client / api / OperationContext.html
blob: e2cdcc334f5ab3424fc2d752d545eaf56424bf83 [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 (version 1.7.0_07) on Wed Sep 18 18:26:08 EDT 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>OperationContext (Apache Chemistry OpenCMIS 0.10.0)</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="OperationContext (Apache Chemistry OpenCMIS 0.10.0)";
}
//-->
</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/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="strong">Prev 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="strong">Next 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 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:&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/1.5.0/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="strong">OperationContext</span>
extends <a href="http://docs.oracle.com/javase/1.5.0/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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</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://docs.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/client/api/OperationContext.html#getCacheKey()">getCacheKey</a></strong>()</code>
<div class="block">Returns a key for this OperationContext object that is used for caching.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/1.5.0/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><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#getFilter()">getFilter</a></strong>()</code>
<div class="block">Returns the current filter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.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/client/api/OperationContext.html#getFilterString()">getFilterString</a></strong>()</code>
<div class="block">Returns the filter extended by cmis:objectId, cmis:objectTypeId and
cmis:baseTypeId.</div>
</td>
</tr>
<tr 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><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#getIncludeRelationships()">getIncludeRelationships</a></strong>()</code>
<div class="block">Returns which relationships should be returned.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#getMaxItemsPerPage()">getMaxItemsPerPage</a></strong>()</code>
<div class="block">Returns the current max number of items per batch.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.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/client/api/OperationContext.html#getOrderBy()">getOrderBy</a></strong>()</code>
<div class="block">Returns the order by rule for operations that return lists.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/1.5.0/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><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#getRenditionFilter()">getRenditionFilter</a></strong>()</code>
<div class="block">Returns the current rendition filter.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.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/client/api/OperationContext.html#getRenditionFilterString()">getRenditionFilterString</a></strong>()</code>
<div class="block">Returns the current rendition filter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#isCacheEnabled()">isCacheEnabled</a></strong>()</code>
<div class="block">Return if caching is enabled.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#isIncludeAcls()">isIncludeAcls</a></strong>()</code>
<div class="block">Returns if ACLs should returned.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#isIncludeAllowableActions()">isIncludeAllowableActions</a></strong>()</code>
<div class="block">Returns if allowable actions should returned.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#isIncludePathSegments()">isIncludePathSegments</a></strong>()</code>
<div class="block">Returns if path segments should returned.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#isIncludePolicies()">isIncludePolicies</a></strong>()</code>
<div class="block">Returns if policies should returned.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#loadSecondaryTypeProperties()">loadSecondaryTypeProperties</a></strong>()</code>
<div class="block">Returns is secondary type properties should be loaded.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setCacheEnabled(boolean)">setCacheEnabled</a></strong>(boolean&nbsp;cacheEnabled)</code>
<div class="block">Enables or disables the cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setFilter(java.util.Set)">setFilter</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/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/1.5.0/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 class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setFilterString(java.lang.String)">setFilterString</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/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 class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setIncludeAcls(boolean)">setIncludeAcls</a></strong>(boolean&nbsp;include)</code>
<div class="block">Sets if ACLs should returned.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setIncludeAllowableActions(boolean)">setIncludeAllowableActions</a></strong>(boolean&nbsp;include)</code>
<div class="block">Sets if allowable actions should returned.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setIncludePathSegments(boolean)">setIncludePathSegments</a></strong>(boolean&nbsp;include)</code>
<div class="block">Sets if path segments should returned.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setIncludePolicies(boolean)">setIncludePolicies</a></strong>(boolean&nbsp;include)</code>
<div class="block">Sets if policies should returned.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setIncludeRelationships(org.apache.chemistry.opencmis.commons.enums.IncludeRelationships)">setIncludeRelationships</a></strong>(<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 class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setLoadSecondaryTypeProperties(boolean)">setLoadSecondaryTypeProperties</a></strong>(boolean&nbsp;load)</code>
<div class="block">Sets if secondary type properties should be loaded.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setMaxItemsPerPage(int)">setMaxItemsPerPage</a></strong>(int&nbsp;maxItemsPerPage)</code>
<div class="block">Set the max number of items per batch for operations that return lists.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setOrderBy(java.lang.String)">setOrderBy</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/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 class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setRenditionFilter(java.util.Set)">setRenditionFilter</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/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/1.5.0/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 class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html#setRenditionFilterString(java.lang.String)">setRenditionFilterString</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/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/1.5.0/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/1.5.0/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="strong">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/1.5.0/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/1.5.0/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="strong">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/1.5.0/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="strong">Parameters:</span></dt><dd><code>propertyFilter</code> - a comma separated list of <em>query names</em></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/1.5.0/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="strong">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="strong">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/1.5.0/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/1.5.0/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="strong">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/1.5.0/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/1.5.0/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="strong">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/1.5.0/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="strong">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/1.5.0/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="strong">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/1.5.0/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="strong">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/1.5.0/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="strong">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/1.5.0/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="strong">Parameters:</span></dt><dd><code>maxItemsPerPage</code> - max number of items (must be >0)</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><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/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="strong">Prev 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="strong">Next 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 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:&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-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>