| <!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>Preferences (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="Preferences (Olingo-OData 4.5.0 API)"; | |
| } | |
| } | |
| catch(err) { | |
| } | |
| //--> | |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6}; | |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/Preferences.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/olingo/server/api/prefer/Preferences.Preference.html" title="class in org.apache.olingo.server.api.prefer"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../index.html?org/apache/olingo/server/api/prefer/Preferences.html" target="_top">Frames</a></li> | |
| <li><a href="Preferences.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.olingo.server.api.prefer</div> | |
| <h2 title="Interface Preferences" class="title">Interface Preferences</h2> | |
| </div> | |
| <div class="contentContainer"> | |
| <div class="description"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <hr> | |
| <br> | |
| <pre>public interface <span class="typeNameLabel">Preferences</span></pre> | |
| <div class="block">Provides access methods to the preferences set in Prefer HTTP request headers | |
| as described in <a href="https://www.ietf.org/rfc/rfc7240.txt">RFC 7240</a>. | |
| Preferences defined in the OData standard can be accessed with named methods.</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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/prefer/Preferences.Preference.html" title="class in org.apache.olingo.server.api.prefer">Preferences.Preference</a></span></code> | |
| <div class="block">Generic preference object.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><code>static class </code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/prefer/Preferences.Return.html" title="enum in org.apache.olingo.server.api.prefer">Preferences.Return</a></span></code> </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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/net/URI.html?is-external=true" title="class or interface in java.net">URI</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/prefer/Preferences.html#getCallback--">getCallback</a></span>()</code> | |
| <div class="block">Gets the value of the <code>url</code> parameter of the preference | |
| <code>odata.callback</code> or <code>null</code> if not set or the URI is not valid.</div> | |
| </td> | |
| </tr> | |
| <tr id="i1" class="rowColor"> | |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/prefer/Preferences.html#getMaxPageSize--">getMaxPageSize</a></span>()</code> | |
| <div class="block">Gets the value of the preference <code>odata.maxpagesize</code> | |
| or <code>null</code> if not set or an invalid value has been set.</div> | |
| </td> | |
| </tr> | |
| <tr id="i2" class="altColor"> | |
| <td class="colFirst"><code><a href="../../../../../../org/apache/olingo/server/api/prefer/Preferences.Preference.html" title="class in org.apache.olingo.server.api.prefer">Preferences.Preference</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/prefer/Preferences.html#getPreference-java.lang.String-">getPreference</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">Gets named preference.</div> | |
| </td> | |
| </tr> | |
| <tr id="i3" class="rowColor"> | |
| <td class="colFirst"><code><a href="../../../../../../org/apache/olingo/server/api/prefer/Preferences.Return.html" title="enum in org.apache.olingo.server.api.prefer">Preferences.Return</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/prefer/Preferences.html#getReturn--">getReturn</a></span>()</code> | |
| <div class="block">Gets the value of the preference <code>return</code> or <code>null</code> if not set | |
| or the value is not valid.</div> | |
| </td> | |
| </tr> | |
| <tr id="i4" class="altColor"> | |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/prefer/Preferences.html#getWait--">getWait</a></span>()</code> | |
| <div class="block">Gets the value of the preference <code>wait</code> or <code>null</code> if not set | |
| or the value is not valid.</div> | |
| </td> | |
| </tr> | |
| <tr id="i5" class="rowColor"> | |
| <td class="colFirst"><code>boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/prefer/Preferences.html#hasAllowEntityReferences--">hasAllowEntityReferences</a></span>()</code> | |
| <div class="block">Whether the preference <code>odata.allow-entityreferences</code> has been set.</div> | |
| </td> | |
| </tr> | |
| <tr id="i6" class="altColor"> | |
| <td class="colFirst"><code>boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/prefer/Preferences.html#hasContinueOnError--">hasContinueOnError</a></span>()</code> | |
| <div class="block">Whether the preference <code>odata.continue-on-error</code> has been set.</div> | |
| </td> | |
| </tr> | |
| <tr id="i7" class="rowColor"> | |
| <td class="colFirst"><code>boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/prefer/Preferences.html#hasRespondAsync--">hasRespondAsync</a></span>()</code> | |
| <div class="block">Whether the preference <code>respond-async</code> has been set.</div> | |
| </td> | |
| </tr> | |
| <tr id="i8" class="altColor"> | |
| <td class="colFirst"><code>boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/prefer/Preferences.html#hasTrackChanges--">hasTrackChanges</a></span>()</code> | |
| <div class="block">Whether the preference <code>odata.track-changes</code> has been set.</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="getPreference-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getPreference</h4> | |
| <pre><a href="../../../../../../org/apache/olingo/server/api/prefer/Preferences.Preference.html" title="class in org.apache.olingo.server.api.prefer">Preferences.Preference</a> getPreference(<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">Gets named preference. Names are case insensitive.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>name</code> - name of the preference</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd><a href="../../../../../../org/apache/olingo/server/api/prefer/Preferences.Preference.html" title="class in org.apache.olingo.server.api.prefer"><code>Preferences.Preference</code></a> or <code>null</code> if no such preference has been set</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="hasAllowEntityReferences--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>hasAllowEntityReferences</h4> | |
| <pre>boolean hasAllowEntityReferences()</pre> | |
| <div class="block">Whether the preference <code>odata.allow-entityreferences</code> has been set.</div> | |
| </li> | |
| </ul> | |
| <a name="getCallback--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getCallback</h4> | |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> getCallback()</pre> | |
| <div class="block">Gets the value of the <code>url</code> parameter of the preference | |
| <code>odata.callback</code> or <code>null</code> if not set or the URI is not valid.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>the callback URI</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="hasContinueOnError--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>hasContinueOnError</h4> | |
| <pre>boolean hasContinueOnError()</pre> | |
| <div class="block">Whether the preference <code>odata.continue-on-error</code> has been set.</div> | |
| </li> | |
| </ul> | |
| <a name="getMaxPageSize--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getMaxPageSize</h4> | |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> getMaxPageSize()</pre> | |
| <div class="block">Gets the value of the preference <code>odata.maxpagesize</code> | |
| or <code>null</code> if not set or an invalid value has been set.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>the page size for server-driven paging</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="hasTrackChanges--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>hasTrackChanges</h4> | |
| <pre>boolean hasTrackChanges()</pre> | |
| <div class="block">Whether the preference <code>odata.track-changes</code> has been set.</div> | |
| </li> | |
| </ul> | |
| <a name="getReturn--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getReturn</h4> | |
| <pre><a href="../../../../../../org/apache/olingo/server/api/prefer/Preferences.Return.html" title="enum in org.apache.olingo.server.api.prefer">Preferences.Return</a> getReturn()</pre> | |
| <div class="block">Gets the value of the preference <code>return</code> or <code>null</code> if not set | |
| or the value is not valid.</div> | |
| </li> | |
| </ul> | |
| <a name="hasRespondAsync--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>hasRespondAsync</h4> | |
| <pre>boolean hasRespondAsync()</pre> | |
| <div class="block">Whether the preference <code>respond-async</code> has been set.</div> | |
| </li> | |
| </ul> | |
| <a name="getWait--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>getWait</h4> | |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> getWait()</pre> | |
| <div class="block">Gets the value of the preference <code>wait</code> or <code>null</code> if not set | |
| or the value is not valid.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>the number of seconds the client is prepared to wait for the service | |
| to process the request synchronously</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/Preferences.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/olingo/server/api/prefer/Preferences.Preference.html" title="class in org.apache.olingo.server.api.prefer"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../index.html?org/apache/olingo/server/api/prefer/Preferences.html" target="_top">Frames</a></li> | |
| <li><a href="Preferences.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 © 2013–2018 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> | |
| </body> | |
| </html> |