| <!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 Mon Apr 07 19:25:57 EDT 2014 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>QueryResult (Apache Chemistry OpenCMIS 0.11.0)</title> |
| <meta name="date" content="2014-04-07"> |
| <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="QueryResult (Apache Chemistry OpenCMIS 0.11.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/QueryResult.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/Property.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/QueryStatement.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/QueryResult.html" target="_top">Frames</a></li> |
| <li><a href="QueryResult.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 QueryResult" class="title">Interface QueryResult</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">QueryResult</span></pre> |
| <div class="block">Query result.</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><a href="../../../../../../org/apache/chemistry/opencmis/commons/data/AllowableActions.html" title="interface in org.apache.chemistry.opencmis.commons.data">AllowableActions</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/QueryResult.html#getAllowableActions()">getAllowableActions</a></strong>()</code> |
| <div class="block">Returns the allowable actions if they have been requested.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/PropertyData.html" title="interface in org.apache.chemistry.opencmis.commons.data">PropertyData</a><?>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/QueryResult.html#getProperties()">getProperties</a></strong>()</code> |
| <div class="block">Returns the list of all properties in this query result.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><T> <a href="../../../../../../org/apache/chemistry/opencmis/commons/data/PropertyData.html" title="interface in org.apache.chemistry.opencmis.commons.data">PropertyData</a><T></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/QueryResult.html#getPropertyById(java.lang.String)">getPropertyById</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> id)</code> |
| <div class="block">Returns a property by ID.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><T> <a href="../../../../../../org/apache/chemistry/opencmis/commons/data/PropertyData.html" title="interface in org.apache.chemistry.opencmis.commons.data">PropertyData</a><T></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/QueryResult.html#getPropertyByQueryName(java.lang.String)">getPropertyByQueryName</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> queryName)</code> |
| <div class="block">Returns a property by query name or alias.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><T> <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><T></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/QueryResult.html#getPropertyMultivalueById(java.lang.String)">getPropertyMultivalueById</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> id)</code> |
| <div class="block">Returns a property multi-value by ID.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><T> <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><T></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/QueryResult.html#getPropertyMultivalueByQueryName(java.lang.String)">getPropertyMultivalueByQueryName</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> queryName)</code> |
| <div class="block">Returns a property multi-value by query name or alias.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/QueryResult.html#getPropertyValueById(java.lang.String)">getPropertyValueById</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> id)</code> |
| <div class="block">Returns a property (single) value by ID.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/QueryResult.html#getPropertyValueByQueryName(java.lang.String)">getPropertyValueByQueryName</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> queryName)</code> |
| <div class="block">Returns a property (single) value by query name or alias.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/chemistry/opencmis/client/api/Relationship.html" title="interface in org.apache.chemistry.opencmis.client.api">Relationship</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/QueryResult.html#getRelationships()">getRelationships</a></strong>()</code> |
| <div class="block">Returns the relationships if they have been requested.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/chemistry/opencmis/client/api/Rendition.html" title="interface in org.apache.chemistry.opencmis.client.api">Rendition</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/QueryResult.html#getRenditions()">getRenditions</a></strong>()</code> |
| <div class="block">Returns the renditions if they have been requested.</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="getProperties()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperties</h4> |
| <pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/PropertyData.html" title="interface in org.apache.chemistry.opencmis.commons.data">PropertyData</a><?>> getProperties()</pre> |
| <div class="block">Returns the list of all properties in this query result.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>all properties, not <code>null</code></dd></dl> |
| </li> |
| </ul> |
| <a name="getPropertyById(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPropertyById</h4> |
| <pre><T> <a href="../../../../../../org/apache/chemistry/opencmis/commons/data/PropertyData.html" title="interface in org.apache.chemistry.opencmis.commons.data">PropertyData</a><T> getPropertyById(<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> id)</pre> |
| <div class="block">Returns a property by ID. |
| <p> |
| Because repositories are not obligated to add property IDs to their query |
| result properties, this method might not always work as expected with |
| some repositories. Use <a href="../../../../../../org/apache/chemistry/opencmis/client/api/QueryResult.html#getPropertyByQueryName(java.lang.String)"><code>getPropertyByQueryName(String)</code></a> instead.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - the property ID</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the property or <code>null</code> if the property doesn't exist or |
| hasn't been requested</dd></dl> |
| </li> |
| </ul> |
| <a name="getPropertyByQueryName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPropertyByQueryName</h4> |
| <pre><T> <a href="../../../../../../org/apache/chemistry/opencmis/commons/data/PropertyData.html" title="interface in org.apache.chemistry.opencmis.commons.data">PropertyData</a><T> getPropertyByQueryName(<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> queryName)</pre> |
| <div class="block">Returns a property by query name or alias.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>queryName</code> - the property query name or alias</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the property or <code>null</code> if the property doesn't exist or |
| hasn't been requested</dd></dl> |
| </li> |
| </ul> |
| <a name="getPropertyValueById(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPropertyValueById</h4> |
| <pre><T> T getPropertyValueById(<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> id)</pre> |
| <div class="block">Returns a property (single) value by ID.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - the property ID</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/chemistry/opencmis/client/api/QueryResult.html#getPropertyById(java.lang.String)"><code>getPropertyById(String)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getPropertyValueByQueryName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPropertyValueByQueryName</h4> |
| <pre><T> T getPropertyValueByQueryName(<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> queryName)</pre> |
| <div class="block">Returns a property (single) value by query name or alias.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>queryName</code> - the property query name or alias</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the property value or <code>null</code> if the property doesn't exist, |
| hasn't been requested, or the property value isn't set</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/chemistry/opencmis/client/api/QueryResult.html#getPropertyByQueryName(java.lang.String)"><code>getPropertyByQueryName(String)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getPropertyMultivalueById(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPropertyMultivalueById</h4> |
| <pre><T> <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><T> getPropertyMultivalueById(<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> id)</pre> |
| <div class="block">Returns a property multi-value by ID.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - the property ID</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the property value or <code>null</code> if the property doesn't exist, |
| hasn't been requested, or the property value isn't set</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/chemistry/opencmis/client/api/QueryResult.html#getPropertyById(java.lang.String)"><code>getPropertyById(String)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getPropertyMultivalueByQueryName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPropertyMultivalueByQueryName</h4> |
| <pre><T> <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><T> getPropertyMultivalueByQueryName(<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> queryName)</pre> |
| <div class="block">Returns a property multi-value by query name or alias.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>queryName</code> - the property query name or alias</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the property value or <code>null</code> if the property doesn't exist, |
| hasn't been requested, or the property value isn't set</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/chemistry/opencmis/client/api/QueryResult.html#getPropertyByQueryName(java.lang.String)"><code>getPropertyByQueryName(String)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getAllowableActions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllowableActions</h4> |
| <pre><a href="../../../../../../org/apache/chemistry/opencmis/commons/data/AllowableActions.html" title="interface in org.apache.chemistry.opencmis.commons.data">AllowableActions</a> getAllowableActions()</pre> |
| <div class="block">Returns the allowable actions if they have been requested.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the allowable actions if they have been requested, <code>null</code> |
| otherwise</dd></dl> |
| </li> |
| </ul> |
| <a name="getRelationships()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRelationships</h4> |
| <pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/chemistry/opencmis/client/api/Relationship.html" title="interface in org.apache.chemistry.opencmis.client.api">Relationship</a>> getRelationships()</pre> |
| <div class="block">Returns the relationships if they have been requested.</div> |
| </li> |
| </ul> |
| <a name="getRenditions()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getRenditions</h4> |
| <pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/chemistry/opencmis/client/api/Rendition.html" title="interface in org.apache.chemistry.opencmis.client.api">Rendition</a>> getRenditions()</pre> |
| <div class="block">Returns the renditions if they have been requested.</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/QueryResult.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/Property.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/QueryStatement.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/QueryResult.html" target="_top">Frames</a></li> |
| <li><a href="QueryResult.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-2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |