| <!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:34 CEST 2018 --> | |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
| <title>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="QueryOption (Olingo-OData 4.5.0 API)"; | |
| } | |
| } | |
| catch(err) { | |
| } | |
| //--> | |
| var methods = {"i0":10,"i1":9,"i2":9}; | |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; | |
| var altColor = "altColor"; | |
| var rowColor = "rowColor"; | |
| var tableTab = "tableTab"; | |
| var activeTableTab = "activeTableTab"; | |
| </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><a href="package-summary.html">Package</a></li> | |
| <li class="navBarCell1Rev">Class</li> | |
| <li><a href="class-use/QueryOption.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/client/api/uri/FilterFactory.html" title="interface in org.apache.olingo.client.api.uri"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../../../org/apache/olingo/client/api/uri/SearchFactory.html" title="interface in org.apache.olingo.client.api.uri"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../index.html?org/apache/olingo/client/api/uri/QueryOption.html" target="_top">Frames</a></li> | |
| <li><a href="QueryOption.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><a href="#enum.constant.summary">Enum Constants</a> | </li> | |
| <li>Field | </li> | |
| <li><a href="#method.summary">Method</a></li> | |
| </ul> | |
| <ul class="subNavList"> | |
| <li>Detail: </li> | |
| <li><a href="#enum.constant.detail">Enum Constants</a> | </li> | |
| <li>Field | </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.olingo.client.api.uri</div> | |
| <h2 title="Enum QueryOption" class="title">Enum QueryOption</h2> | |
| </div> | |
| <div class="contentContainer"> | |
| <ul class="inheritance"> | |
| <li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> | |
| <li> | |
| <ul class="inheritance"> | |
| <li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html" title="enum in org.apache.olingo.client.api.uri">QueryOption</a>></li> | |
| <li> | |
| <ul class="inheritance"> | |
| <li>org.apache.olingo.client.api.uri.QueryOption</li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <div class="description"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <dl> | |
| <dt>All Implemented Interfaces:</dt> | |
| <dd><a href="http://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html" title="enum in org.apache.olingo.client.api.uri">QueryOption</a>></dd> | |
| </dl> | |
| <hr> | |
| <br> | |
| <pre>public enum <span class="typeNameLabel">QueryOption</span> | |
| extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><<a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html" title="enum in org.apache.olingo.client.api.uri">QueryOption</a>></pre> | |
| <div class="block">Query options.</div> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="summary"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <!-- =========== ENUM CONSTANT SUMMARY =========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="enum.constant.summary"> | |
| <!-- --> | |
| </a> | |
| <h3>Enum Constant Summary</h3> | |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> | |
| <caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> | |
| <tr> | |
| <th class="colOne" scope="col">Enum Constant and Description</th> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html#COUNT">COUNT</a></span></code> | |
| <div class="block">The $count system query option allows clients to request a count of the matching resources included with the | |
| resources in the response.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html#EXPAND">EXPAND</a></span></code> | |
| <div class="block">This option indicates entities associated with the EntityType instance or EntitySet, identified by the resource | |
| path section of the URI, and MUST be represented inline in the data service's response.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html#FILTER">FILTER</a></span></code> | |
| <div class="block">This option specifies a predicate used to filter the elements from the EntitySet identified by the resource path | |
| section of the URI.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html#FORMAT">FORMAT</a></span></code> | |
| <div class="block">This option specifies the media type acceptable in a response.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html#ID">ID</a></span></code> | |
| <div class="block">The entity-id specified by $id may be expressed absolute or relative to the request URL.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html#LEVELS">LEVELS</a></span></code> | |
| <div class="block">Cyclic navigation properties (whose target type is identical or can be cast to its source type) can be recursively | |
| expanded using the special <tt>$levels</tt> option.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html#ORDERBY">ORDERBY</a></span></code> | |
| <div class="block">This option specifies the sort properties and sort direction (ascending or descending) that the data service MUST | |
| use to order the entities in the EntitySet, identified by the resource path section of the URI.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html#SEARCH">SEARCH</a></span></code> | |
| <div class="block">Search expressions are used within the $search system query option to request entities matching the specified | |
| expression.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html#SELECT">SELECT</a></span></code> | |
| <div class="block">This option is used to specify that a subset of the properties of the entities identified by the path of the | |
| request URI and $expand query option SHOULD be returned in the response from the data service.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html#SKIP">SKIP</a></span></code> | |
| <div class="block">This option specifies a positive integer N that represents the number of entities, counted from the first entity in | |
| the EntitySet and ordered as specified by the $orderby option, that the data service should skip when returning the | |
| entities in the EntitySet, which is identified by the resource path section of the URI.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html#SKIPTOKEN">SKIPTOKEN</a></span></code> | |
| <div class="block">The value of a $skiptoken query option is an opaque token which identifies an index into the collection | |
| of entities identified by the URI containing the $skiptoken parameter.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html#TOP">TOP</a></span></code> | |
| <div class="block">This option specifies a positive integer N that is the maximum number of entities in the EntitySet, identified by | |
| the resource path section of the URI, that the data service MUST return.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> | |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> | |
| <tr> | |
| <th class="colFirst" scope="col">Modifier and Type</th> | |
| <th class="colLast" scope="col">Method and Description</th> | |
| </tr> | |
| <tr id="i0" class="altColor"> | |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html#toString--">toString</a></span>()</code> </td> | |
| </tr> | |
| <tr id="i1" class="rowColor"> | |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html" title="enum in org.apache.olingo.client.api.uri">QueryOption</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html#valueOf-java.lang.String-">valueOf</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> | |
| <div class="block">Returns the enum constant of this type with the specified name.</div> | |
| </td> | |
| </tr> | |
| <tr id="i2" class="altColor"> | |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html" title="enum in org.apache.olingo.client.api.uri">QueryOption</a>[]</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html#values--">values</a></span>()</code> | |
| <div class="block">Returns an array containing the constants of this enum type, in | |
| the order they are declared.</div> | |
| </td> | |
| </tr> | |
| </table> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> | |
| <!-- --> | |
| </a> | |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3> | |
| <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#compareTo-E-" title="class or interface in java.lang">compareTo</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass--" title="class or interface in java.lang">getDeclaringClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#name--" title="class or interface in java.lang">name</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#ordinal--" title="class or interface in java.lang">ordinal</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang">valueOf</a></code></li> | |
| </ul> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> | |
| <!-- --> | |
| </a> | |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> | |
| <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="details"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <!-- ============ ENUM CONSTANT DETAIL =========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="enum.constant.detail"> | |
| <!-- --> | |
| </a> | |
| <h3>Enum Constant Detail</h3> | |
| <a name="ID"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>ID</h4> | |
| <pre>public static final <a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html" title="enum in org.apache.olingo.client.api.uri">QueryOption</a> ID</pre> | |
| <div class="block">The entity-id specified by $id may be expressed absolute or relative to the request URL.</div> | |
| </li> | |
| </ul> | |
| <a name="COUNT"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>COUNT</h4> | |
| <pre>public static final <a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html" title="enum in org.apache.olingo.client.api.uri">QueryOption</a> COUNT</pre> | |
| <div class="block">The $count system query option allows clients to request a count of the matching resources included with the | |
| resources in the response. The $count query option has a Boolean value of true or false.</div> | |
| </li> | |
| </ul> | |
| <a name="EXPAND"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>EXPAND</h4> | |
| <pre>public static final <a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html" title="enum in org.apache.olingo.client.api.uri">QueryOption</a> EXPAND</pre> | |
| <div class="block">This option indicates entities associated with the EntityType instance or EntitySet, identified by the resource | |
| path section of the URI, and MUST be represented inline in the data service's response.</div> | |
| </li> | |
| </ul> | |
| <a name="LEVELS"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>LEVELS</h4> | |
| <pre>public static final <a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html" title="enum in org.apache.olingo.client.api.uri">QueryOption</a> LEVELS</pre> | |
| <div class="block">Cyclic navigation properties (whose target type is identical or can be cast to its source type) can be recursively | |
| expanded using the special <tt>$levels</tt> option. The value of the $levels option is either a positive integer to | |
| specify the number of levels to expand, or the literal string max to specify the maximum expansion level supported | |
| by that service.</div> | |
| </li> | |
| </ul> | |
| <a name="FORMAT"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>FORMAT</h4> | |
| <pre>public static final <a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html" title="enum in org.apache.olingo.client.api.uri">QueryOption</a> FORMAT</pre> | |
| <div class="block">This option specifies the media type acceptable in a response. If present, this value SHOULD take precedence over | |
| value(s) specified in an Accept request header.</div> | |
| </li> | |
| </ul> | |
| <a name="SELECT"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>SELECT</h4> | |
| <pre>public static final <a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html" title="enum in org.apache.olingo.client.api.uri">QueryOption</a> SELECT</pre> | |
| <div class="block">This option is used to specify that a subset of the properties of the entities identified by the path of the | |
| request URI and $expand query option SHOULD be returned in the response from the data service.</div> | |
| </li> | |
| </ul> | |
| <a name="ORDERBY"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>ORDERBY</h4> | |
| <pre>public static final <a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html" title="enum in org.apache.olingo.client.api.uri">QueryOption</a> ORDERBY</pre> | |
| <div class="block">This option specifies the sort properties and sort direction (ascending or descending) that the data service MUST | |
| use to order the entities in the EntitySet, identified by the resource path section of the URI.</div> | |
| </li> | |
| </ul> | |
| <a name="TOP"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>TOP</h4> | |
| <pre>public static final <a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html" title="enum in org.apache.olingo.client.api.uri">QueryOption</a> TOP</pre> | |
| <div class="block">This option specifies a positive integer N that is the maximum number of entities in the EntitySet, identified by | |
| the resource path section of the URI, that the data service MUST return.</div> | |
| </li> | |
| </ul> | |
| <a name="SKIP"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>SKIP</h4> | |
| <pre>public static final <a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html" title="enum in org.apache.olingo.client.api.uri">QueryOption</a> SKIP</pre> | |
| <div class="block">This option specifies a positive integer N that represents the number of entities, counted from the first entity in | |
| the EntitySet and ordered as specified by the $orderby option, that the data service should skip when returning the | |
| entities in the EntitySet, which is identified by the resource path section of the URI. The data service SHOULD | |
| return all subsequent entities, starting from the one in position N+1.</div> | |
| </li> | |
| </ul> | |
| <a name="SKIPTOKEN"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>SKIPTOKEN</h4> | |
| <pre>public static final <a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html" title="enum in org.apache.olingo.client.api.uri">QueryOption</a> SKIPTOKEN</pre> | |
| <div class="block">The value of a $skiptoken query option is an opaque token which identifies an index into the collection | |
| of entities identified by the URI containing the $skiptoken parameter.</div> | |
| </li> | |
| </ul> | |
| <a name="FILTER"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>FILTER</h4> | |
| <pre>public static final <a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html" title="enum in org.apache.olingo.client.api.uri">QueryOption</a> FILTER</pre> | |
| <div class="block">This option specifies a predicate used to filter the elements from the EntitySet identified by the resource path | |
| section of the URI.</div> | |
| </li> | |
| </ul> | |
| <a name="SEARCH"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>SEARCH</h4> | |
| <pre>public static final <a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html" title="enum in org.apache.olingo.client.api.uri">QueryOption</a> SEARCH</pre> | |
| <div class="block">Search expressions are used within the $search system query option to request entities matching the specified | |
| expression.</div> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <!-- ============ METHOD DETAIL ========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="method.detail"> | |
| <!-- --> | |
| </a> | |
| <h3>Method Detail</h3> | |
| <a name="values--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>values</h4> | |
| <pre>public static <a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html" title="enum in org.apache.olingo.client.api.uri">QueryOption</a>[] values()</pre> | |
| <div class="block">Returns an array containing the constants of this enum type, in | |
| the order they are declared. This method may be used to iterate | |
| over the constants as follows: | |
| <pre> | |
| for (QueryOption c : QueryOption.values()) | |
| System.out.println(c); | |
| </pre></div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>an array containing the constants of this enum type, in the order they are declared</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="valueOf-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>valueOf</h4> | |
| <pre>public static <a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html" title="enum in org.apache.olingo.client.api.uri">QueryOption</a> valueOf(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> | |
| <div class="block">Returns the enum constant of this type with the specified name. | |
| The string must match <i>exactly</i> an identifier used to declare an | |
| enum constant in this type. (Extraneous whitespace characters are | |
| not permitted.)</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>name</code> - the name of the enum constant to be returned.</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>the enum constant with the specified name</dd> | |
| <dt><span class="throwsLabel">Throws:</span></dt> | |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> | |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="toString--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>toString</h4> | |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> | |
| <dl> | |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> | |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><<a href="../../../../../../org/apache/olingo/client/api/uri/QueryOption.html" title="enum in org.apache.olingo.client.api.uri">QueryOption</a>></code></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> | |
| <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><a href="package-summary.html">Package</a></li> | |
| <li class="navBarCell1Rev">Class</li> | |
| <li><a href="class-use/QueryOption.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/client/api/uri/FilterFactory.html" title="interface in org.apache.olingo.client.api.uri"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../../../org/apache/olingo/client/api/uri/SearchFactory.html" title="interface in org.apache.olingo.client.api.uri"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../index.html?org/apache/olingo/client/api/uri/QueryOption.html" target="_top">Frames</a></li> | |
| <li><a href="QueryOption.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><a href="#enum.constant.summary">Enum Constants</a> | </li> | |
| <li>Field | </li> | |
| <li><a href="#method.summary">Method</a></li> | |
| </ul> | |
| <ul class="subNavList"> | |
| <li>Detail: </li> | |
| <li><a href="#enum.constant.detail">Enum Constants</a> | </li> | |
| <li>Field | </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 © 2013–2018 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> | |
| </body> | |
| </html> |