| <!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_25) on Thu Jun 20 13:09:11 CEST 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>ItemIterable (Apache Chemistry OpenCMIS 0.9.0)</title> |
| <meta name="date" content="2013-06-20"> |
| <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="ItemIterable (Apache Chemistry OpenCMIS 0.9.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/ItemIterable.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/Item.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/ItemType.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/ItemIterable.html" target="_top">Frames</a></li> |
| <li><a href="ItemIterable.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.chemistry.opencmis.client.api</div> |
| <h2 title="Interface ItemIterable" class="title">Interface ItemIterable<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - the type of the items</dd></dl> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><T></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">ItemIterable<T></span> |
| extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><T></pre> |
| <div class="block">Iterable for CMIS collections that allows ability to skip to specific |
| position or return a subcollection.</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"> </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>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html#getHasMoreItems()">getHasMoreItems</a></strong>()</code> |
| <div class="block">Returns whether the repository contains additional items beyond the page of |
| items already fetched.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="interface in org.apache.chemistry.opencmis.client.api">ItemIterable</a><<a href="../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="type parameter in ItemIterable">T</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html#getPage()">getPage</a></strong>()</code> |
| <div class="block">Gets an iterable for the current sub collection within the CMIS collection using |
| default maximum number of items</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="interface in org.apache.chemistry.opencmis.client.api">ItemIterable</a><<a href="../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="type parameter in ItemIterable">T</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html#getPage(int)">getPage</a></strong>(int maxNumItems)</code> |
| <div class="block">Gets an iterable for the current sub collection within the CMIS collection</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html#getPageNumItems()">getPageNumItems</a></strong>()</code> |
| <div class="block">Returns the number of items fetched for the current page.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html#getTotalNumItems()">getTotalNumItems</a></strong>()</code> |
| <div class="block">Returns the total number of items.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="type parameter in ItemIterable">T</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html#iterator()">iterator</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="interface in org.apache.chemistry.opencmis.client.api">ItemIterable</a><<a href="../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="type parameter in ItemIterable">T</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html#skipTo(long)">skipTo</a></strong>(long position)</code> |
| <div class="block">Skip to position within CMIS collection</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="skipTo(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>skipTo</h4> |
| <pre><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="interface in org.apache.chemistry.opencmis.client.api">ItemIterable</a><<a href="../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="type parameter in ItemIterable">T</a>> skipTo(long position)</pre> |
| <div class="block">Skip to position within CMIS collection</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>position</code> - </dd> |
| <dt><span class="strong">Returns:</span></dt><dd>iterable whose starting point is the specified skip to position. |
| This iterable <em>may</em> be the same as <code>this</code></dd></dl> |
| </li> |
| </ul> |
| <a name="getPage()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPage</h4> |
| <pre><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="interface in org.apache.chemistry.opencmis.client.api">ItemIterable</a><<a href="../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="type parameter in ItemIterable">T</a>> getPage()</pre> |
| <div class="block">Gets an iterable for the current sub collection within the CMIS collection using |
| default maximum number of items</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>iterable for current page</dd></dl> |
| </li> |
| </ul> |
| <a name="getPage(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPage</h4> |
| <pre><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="interface in org.apache.chemistry.opencmis.client.api">ItemIterable</a><<a href="../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="type parameter in ItemIterable">T</a>> getPage(int maxNumItems)</pre> |
| <div class="block">Gets an iterable for the current sub collection within the CMIS collection</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>maxNumItems</code> - maximum number of items the sub collection will contain</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>iterable for current page</dd></dl> |
| </li> |
| </ul> |
| <a name="iterator()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>iterator</h4> |
| <pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="type parameter in ItemIterable">T</a>> iterator()</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Iterable.html?is-external=true#iterator()" title="class or interface in java.lang">iterator</a></code> in interface <code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="type parameter in ItemIterable">T</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPageNumItems()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPageNumItems</h4> |
| <pre>long getPageNumItems()</pre> |
| <div class="block">Returns the number of items fetched for the current page.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>number of items for currently fetched collection</dd></dl> |
| </li> |
| </ul> |
| <a name="getHasMoreItems()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHasMoreItems</h4> |
| <pre>boolean getHasMoreItems()</pre> |
| <div class="block">Returns whether the repository contains additional items beyond the page of |
| items already fetched.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>true => further page requests will be made to the repository</dd></dl> |
| </li> |
| </ul> |
| <a name="getTotalNumItems()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getTotalNumItems</h4> |
| <pre>long getTotalNumItems()</pre> |
| <div class="block">Returns the total number of items. If the repository knows the total |
| number of items in a result set, the repository SHOULD include the number |
| here. If the repository does not know the number of items in a result |
| set, this parameter SHOULD not be set. The value in the parameter MAY NOT |
| be accurate the next time the client retrieves the result set or the next |
| page in the result set.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>total number of items or (-1)</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ItemIterable.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/Item.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/ItemType.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/ItemIterable.html" target="_top">Frames</a></li> |
| <li><a href="ItemIterable.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2009-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
