| <!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 Sat Apr 05 09:19:53 EDT 2014 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>Children (Apache Chemistry OpenCMIS 0.11.0 API)</title> |
| <meta name="date" content="2014-04-05"> |
| <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="Children (Apache Chemistry OpenCMIS 0.11.0 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Children.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>Prev Class</li> |
| <li><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Children.ChildrenResult.html" title="class in org.apache.chemistry.opencmis.inmemory.storedobj.api"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/chemistry/opencmis/inmemory/storedobj/api/Children.html" target="_top">Frames</a></li> |
| <li><a href="Children.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><a href="#nested_class_summary">Nested</a> | </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.inmemory.storedobj.api</div> |
| <h2 title="Interface Children" class="title">Interface Children</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">Children</span></pre> |
| <div class="block">A folder is a StoredObject that that has a path and children. Children can be |
| folder or documents</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Children.ChildrenResult.html" title="class in org.apache.chemistry.opencmis.inmemory.storedobj.api">Children.ChildrenResult</a></strong></code> |
| <div class="block">Class to represent a result of get children calls</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Children.ChildrenResult.html" title="class in org.apache.chemistry.opencmis.inmemory.storedobj.api">Children.ChildrenResult</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Children.html#getChildren(int, int, java.lang.String, boolean)">getChildren</a></strong>(int maxItems, |
| int skipCount, |
| <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> user, |
| boolean usePwc)</code> |
| <div class="block">get all the children of this folder.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Children.ChildrenResult.html" title="class in org.apache.chemistry.opencmis.inmemory.storedobj.api">Children.ChildrenResult</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Children.html#getFolderChildren(int, int, java.lang.String)">getFolderChildren</a></strong>(int maxItems, |
| int skipCount, |
| <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> user)</code> |
| <div class="block">get all the children of this folder which are folders.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Children.html#hasChild(java.lang.String)">hasChild</a></strong>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">indicate if a child with the given name exists in this folder.</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(int, int, java.lang.String, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getChildren</h4> |
| <pre><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Children.ChildrenResult.html" title="class in org.apache.chemistry.opencmis.inmemory.storedobj.api">Children.ChildrenResult</a> getChildren(int maxItems, |
| int skipCount, |
| <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> user, |
| boolean usePwc)</pre> |
| <div class="block">get all the children of this folder. To support paging an initial offset |
| and a maximum number of children to retrieve can be passed.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>maxItems</code> - max. number of items to return</dd><dd><code>skipCount</code> - initial offset where to start fetching</dd><dd><code>user</code> - user to determine visible children</dd><dd><code>usePwc</code> - if true return private working copy otherwise return latest |
| version;</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>list of children objects</dd></dl> |
| </li> |
| </ul> |
| <a name="getFolderChildren(int, int, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFolderChildren</h4> |
| <pre><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Children.ChildrenResult.html" title="class in org.apache.chemistry.opencmis.inmemory.storedobj.api">Children.ChildrenResult</a> getFolderChildren(int maxItems, |
| int skipCount, |
| <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> user)</pre> |
| <div class="block">get all the children of this folder which are folders. To support paging |
| an initial offset and a maximum number of children to retrieve can be |
| passed.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>maxItems</code> - max. number of items to return</dd><dd><code>skipCount</code> - initial offset where to start fetching</dd><dd><code>user</code> - user to determine visible children</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>list of children folders</dd></dl> |
| </li> |
| </ul> |
| <a name="hasChild(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>hasChild</h4> |
| <pre>boolean hasChild(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">indicate if a child with the given name exists in this folder.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - name to check</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>true if the name exists in the folderas child, false otherwise</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/Children.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>Prev Class</li> |
| <li><a href="../../../../../../../org/apache/chemistry/opencmis/inmemory/storedobj/api/Children.ChildrenResult.html" title="class in org.apache.chemistry.opencmis.inmemory.storedobj.api"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/chemistry/opencmis/inmemory/storedobj/api/Children.html" target="_top">Frames</a></li> |
| <li><a href="Children.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><a href="#nested_class_summary">Nested</a> | </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-2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |