| <!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_92) on Mon Aug 13 15:36:38 CEST 2018 --> | |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
| <title>org.apache.olingo.server.api.uri.queryoption (Olingo-OData 4.5.0 API)</title> | |
| <meta name="date" content="2018-08-13"> | |
| <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="org.apache.olingo.server.api.uri.queryoption (Olingo-OData 4.5.0 API)"; | |
| } | |
| } | |
| catch(err) { | |
| } | |
| //--> | |
| </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 class="navBarCell1Rev">Package</li> | |
| <li>Class</li> | |
| <li><a href="package-use.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/olingo/server/api/uri/package-summary.html">Prev Package</a></li> | |
| <li><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/apply/package-summary.html">Next Package</a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../../index.html?org/apache/olingo/server/api/uri/queryoption/package-summary.html" target="_top">Frames</a></li> | |
| <li><a href="package-summary.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> | |
| <a name="skip.navbar.top"> | |
| <!-- --> | |
| </a></div> | |
| <!-- ========= END OF TOP NAVBAR ========= --> | |
| <div class="header"> | |
| <h1 title="Package" class="title">Package org.apache.olingo.server.api.uri.queryoption</h1> | |
| <div class="docSummary"> | |
| <div class="block">Olingo Server API - URI - QueryOptions</div> | |
| </div> | |
| <p>See: <a href="#package.description">Description</a></p> | |
| </div> | |
| <div class="contentContainer"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> | |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> | |
| <tr> | |
| <th class="colFirst" scope="col">Interface</th> | |
| <th class="colLast" scope="col">Description</th> | |
| </tr> | |
| <tbody> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/AliasQueryOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">AliasQueryOption</a></td> | |
| <td class="colLast"> | |
| <div class="block">Represents an alias value defined as query option | |
| For example: | |
| http://.../?filter=@value eq name&@value='test'</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ApplyItem.html" title="interface in org.apache.olingo.server.api.uri.queryoption">ApplyItem</a></td> | |
| <td class="colLast"> | |
| <div class="block">Represents a single transformation from the system query option $apply.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ApplyOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">ApplyOption</a></td> | |
| <td class="colLast"> | |
| <div class="block">Represents the system query option $apply, defined in the data aggregation extension.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/CountOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">CountOption</a></td> | |
| <td class="colLast"> | |
| <div class="block">Represents the system query option $count | |
| For example: | |
| http://.../entitySet?$count=true</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/CustomQueryOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">CustomQueryOption</a></td> | |
| <td class="colLast"> | |
| <div class="block">Represents a custom query option | |
| For example: | |
| http://.../entitySet?myOption=true</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/DeltaTokenOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">DeltaTokenOption</a></td> | |
| <td class="colLast"> </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ExpandItem.html" title="interface in org.apache.olingo.server.api.uri.queryoption">ExpandItem</a></td> | |
| <td class="colLast"> | |
| <div class="block">Represents a single resource path which should be expanded with using the system query option $expand | |
| For example: http://.../entitySet?$expand=Products($filter=DiscontinuedDate eq null)</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ExpandOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">ExpandOption</a></td> | |
| <td class="colLast"> | |
| <div class="block">Represents the system query option $expand | |
| For example: http://.../entitySet?$expand=Products,Customers</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/FilterOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">FilterOption</a></td> | |
| <td class="colLast"> | |
| <div class="block">Represents the system query option $filter | |
| For example: http://.../entitySet?$filter=name eq 'tester'</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/FormatOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">FormatOption</a></td> | |
| <td class="colLast"> | |
| <div class="block">Represents the system query option $format | |
| For example: http://.../entitySet?$format=json</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/IdOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">IdOption</a></td> | |
| <td class="colLast"> | |
| <div class="block">Represents the system query option $id when using a entity-id to resolve the entity | |
| For example: http://.../$entity?$id=Products(0)</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/LevelsExpandOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">LevelsExpandOption</a></td> | |
| <td class="colLast"> | |
| <div class="block">Represents the system query option $levels when used inside $expand | |
| For example: http://.../Employees?$expand=Model.Manager/DirectReports($levels=3)</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/OrderByItem.html" title="interface in org.apache.olingo.server.api.uri.queryoption">OrderByItem</a></td> | |
| <td class="colLast"> | |
| <div class="block">Represents a single orderby information | |
| For example: http://.../Employees?$orderby=Name</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/OrderByOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">OrderByOption</a></td> | |
| <td class="colLast"> | |
| <div class="block">Represents the system query option $orderby | |
| For example: http://.../Employees?$orderby=Name, Age desc</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/QueryOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">QueryOption</a></td> | |
| <td class="colLast"> | |
| <div class="block">Super interface used for any query option</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/SearchOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">SearchOption</a></td> | |
| <td class="colLast"> | |
| <div class="block">Represents the system query option $search | |
| For example: http://.../entitySet?$search=SearchString</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/SelectItem.html" title="interface in org.apache.olingo.server.api.uri.queryoption">SelectItem</a></td> | |
| <td class="colLast"> | |
| <div class="block">Represents a single select item information | |
| For example: http://.../Employees?select=name,age</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/SelectOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">SelectOption</a></td> | |
| <td class="colLast"> | |
| <div class="block">Represents the system query option $select | |
| For example: http://.../entitySet?select=name,age</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/SkipOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">SkipOption</a></td> | |
| <td class="colLast"> | |
| <div class="block">Represents the system query option $skip | |
| For example: http://.../entitySet?$skip=10</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/SkipTokenOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">SkipTokenOption</a></td> | |
| <td class="colLast"> | |
| <div class="block">Represents the system query option $skiptoken | |
| For example: http://.../entitySet?$skiptoken=abv</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/SystemQueryOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">SystemQueryOption</a></td> | |
| <td class="colLast"> | |
| <div class="block">Super interface used for any system query option</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/TopOption.html" title="interface in org.apache.olingo.server.api.uri.queryoption">TopOption</a></td> | |
| <td class="colLast"> | |
| <div class="block">Represents the system query option $top | |
| For example: http://.../entitySet?$top=10</div> | |
| </td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| </li> | |
| <li class="blockList"> | |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> | |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> | |
| <tr> | |
| <th class="colFirst" scope="col">Enum</th> | |
| <th class="colLast" scope="col">Description</th> | |
| </tr> | |
| <tbody> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/ApplyItem.Kind.html" title="enum in org.apache.olingo.server.api.uri.queryoption">ApplyItem.Kind</a></td> | |
| <td class="colLast"> | |
| <div class="block">The kind of the transformation.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/SystemQueryOptionKind.html" title="enum in org.apache.olingo.server.api.uri.queryoption">SystemQueryOptionKind</a></td> | |
| <td class="colLast"> | |
| <div class="block">Defines the supported system query options.</div> | |
| </td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| </li> | |
| </ul> | |
| <a name="package.description"> | |
| <!-- --> | |
| </a> | |
| <h2 title="Package org.apache.olingo.server.api.uri.queryoption Description">Package org.apache.olingo.server.api.uri.queryoption Description</h2> | |
| <div class="block">Olingo Server API - URI - QueryOptions | |
| <p> | |
| The uri.queryoption package is used to condense all about the Olingo query options (in uri context).</div> | |
| </div> | |
| <!-- ======= 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 class="navBarCell1Rev">Package</li> | |
| <li>Class</li> | |
| <li><a href="package-use.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/olingo/server/api/uri/package-summary.html">Prev Package</a></li> | |
| <li><a href="../../../../../../../org/apache/olingo/server/api/uri/queryoption/apply/package-summary.html">Next Package</a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../../index.html?org/apache/olingo/server/api/uri/queryoption/package-summary.html" target="_top">Frames</a></li> | |
| <li><a href="package-summary.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> | |
| <a name="skip.navbar.bottom"> | |
| <!-- --> | |
| </a></div> | |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> | |
| <p class="legalCopy"><small>Copyright © 2013–2018 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> | |
| </body> | |
| </html> |