| <!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:33 CEST 2018 --> | |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
| <title>AsyncResponseWrapper (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="AsyncResponseWrapper (Olingo-OData 4.5.0 API)"; | |
| } | |
| } | |
| catch(err) { | |
| } | |
| //--> | |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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/AsyncResponseWrapper.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/communication/response/AsyncResponse.html" title="interface in org.apache.olingo.client.api.communication.response"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../../../../org/apache/olingo/client/api/communication/response/ODataBatchResponse.html" title="interface in org.apache.olingo.client.api.communication.response"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../../index.html?org/apache/olingo/client/api/communication/response/AsyncResponseWrapper.html" target="_top">Frames</a></li> | |
| <li><a href="AsyncResponseWrapper.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.olingo.client.api.communication.response</div> | |
| <h2 title="Interface AsyncResponseWrapper" class="title">Interface AsyncResponseWrapper<R extends <a href="../../../../../../../org/apache/olingo/client/api/communication/response/ODataResponse.html" title="interface in org.apache.olingo.client.api.communication.response">ODataResponse</a>></h2> | |
| </div> | |
| <div class="contentContainer"> | |
| <div class="description"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <hr> | |
| <br> | |
| <pre>public interface <span class="typeNameLabel">AsyncResponseWrapper<R extends <a href="../../../../../../../org/apache/olingo/client/api/communication/response/ODataResponse.html" title="interface in org.apache.olingo.client.api.communication.response">ODataResponse</a>></span></pre> | |
| </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="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="../../../../../../../org/apache/olingo/client/api/communication/response/AsyncResponseWrapper.html" title="interface in org.apache.olingo.client.api.communication.response">AsyncResponseWrapper</a><<a href="../../../../../../../org/apache/olingo/client/api/communication/response/ODataDeleteResponse.html" title="interface in org.apache.olingo.client.api.communication.response">ODataDeleteResponse</a>></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/client/api/communication/response/AsyncResponseWrapper.html#asyncDelete--">asyncDelete</a></span>()</code> | |
| <div class="block">A client can request that the DELETE should be executed asynchronously.</div> | |
| </td> | |
| </tr> | |
| <tr id="i1" class="rowColor"> | |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/client/api/communication/response/ODataDeleteResponse.html" title="interface in org.apache.olingo.client.api.communication.response">ODataDeleteResponse</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/client/api/communication/response/AsyncResponseWrapper.html#delete--">delete</a></span>()</code> | |
| <div class="block">DeleteA DELETE request sent to the status monitor resource requests that the asynchronous processing be canceled.</div> | |
| </td> | |
| </tr> | |
| <tr id="i2" class="altColor"> | |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/client/api/communication/response/AsyncResponseWrapper.html" title="interface in org.apache.olingo.client.api.communication.response">AsyncResponseWrapper</a><<a href="../../../../../../../org/apache/olingo/client/api/communication/response/AsyncResponseWrapper.html" title="type parameter in AsyncResponseWrapper">R</a>></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/client/api/communication/response/AsyncResponseWrapper.html#forceNextMonitorCheck-java.net.URI-">forceNextMonitorCheck</a></span>(<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> uri)</code> | |
| <div class="block">Specifies the location for the next monitor check.</div> | |
| </td> | |
| </tr> | |
| <tr id="i3" class="rowColor"> | |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/client/api/communication/response/AsyncResponseWrapper.html" title="type parameter in AsyncResponseWrapper">R</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/client/api/communication/response/AsyncResponseWrapper.html#getODataResponse--">getODataResponse</a></span>()</code> | |
| <div class="block">Gets the real response.</div> | |
| </td> | |
| </tr> | |
| <tr id="i4" class="altColor"> | |
| <td class="colFirst"><code>boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/client/api/communication/response/AsyncResponseWrapper.html#isDone--">isDone</a></span>()</code> | |
| <div class="block">Checks if asynchronous processing has been terminated.</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/client/api/communication/response/AsyncResponseWrapper.html#isPreferenceApplied--">isPreferenceApplied</a></span>()</code> | |
| <div class="block">Checks for preference applied.</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="isPreferenceApplied--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>isPreferenceApplied</h4> | |
| <pre>boolean isPreferenceApplied()</pre> | |
| <div class="block">Checks for preference applied.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>'TRUE' if respond-async preference has been applied; 'FALSE' otherwise.</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="isDone--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>isDone</h4> | |
| <pre>boolean isDone()</pre> | |
| <div class="block">Checks if asynchronous processing has been terminated.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>'TRUE' the process has been terminated; 'FALSE' otherwise.</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="getODataResponse--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getODataResponse</h4> | |
| <pre><a href="../../../../../../../org/apache/olingo/client/api/communication/response/AsyncResponseWrapper.html" title="type parameter in AsyncResponseWrapper">R</a> getODataResponse()</pre> | |
| <div class="block">Gets the real response. | |
| <br /> | |
| If asynchronous processing has been terminated then the response will be returned immediately. This method retries | |
| after a delay, specified by the 'Retry-After' header indicating the time, in seconds, the client should wait before | |
| retry. If there isn't any 'Retry-After' response header available, a default of 5 seconds will be chosen. The query | |
| will be retried for a maximum of five times.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>real OData response.</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="forceNextMonitorCheck-java.net.URI-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>forceNextMonitorCheck</h4> | |
| <pre><a href="../../../../../../../org/apache/olingo/client/api/communication/response/AsyncResponseWrapper.html" title="interface in org.apache.olingo.client.api.communication.response">AsyncResponseWrapper</a><<a href="../../../../../../../org/apache/olingo/client/api/communication/response/AsyncResponseWrapper.html" title="type parameter in AsyncResponseWrapper">R</a>> forceNextMonitorCheck(<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> uri)</pre> | |
| <div class="block">Specifies the location for the next monitor check. | |
| <br /> | |
| Overrides the location value retrieved among headers and nullifies the previous valid response (if exists).</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>uri</code> - monitor location.</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>the current async response wrapper.</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="delete--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>delete</h4> | |
| <pre><a href="../../../../../../../org/apache/olingo/client/api/communication/response/ODataDeleteResponse.html" title="interface in org.apache.olingo.client.api.communication.response">ODataDeleteResponse</a> delete()</pre> | |
| <div class="block">DeleteA DELETE request sent to the status monitor resource requests that the asynchronous processing be canceled. A | |
| 200 OK or to a 204 No Content response indicates that the asynchronous processing has been successfully canceled.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>OData delete response.</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="asyncDelete--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>asyncDelete</h4> | |
| <pre><a href="../../../../../../../org/apache/olingo/client/api/communication/response/AsyncResponseWrapper.html" title="interface in org.apache.olingo.client.api.communication.response">AsyncResponseWrapper</a><<a href="../../../../../../../org/apache/olingo/client/api/communication/response/ODataDeleteResponse.html" title="interface in org.apache.olingo.client.api.communication.response">ODataDeleteResponse</a>> asyncDelete()</pre> | |
| <div class="block">A client can request that the DELETE should be executed asynchronously. A 202 Accepted response indicates that the | |
| cancellation is being processed asynchronously; the client can use the returned Location header (which MUST be | |
| different from the status monitor resource of the initial request) to query for the status of the cancellation. If | |
| a delete request is not supported by the service, the service returns 405 Method Not Allowed.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>OData delete response.</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/AsyncResponseWrapper.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/communication/response/AsyncResponse.html" title="interface in org.apache.olingo.client.api.communication.response"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../../../../org/apache/olingo/client/api/communication/response/ODataBatchResponse.html" title="interface in org.apache.olingo.client.api.communication.response"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../../index.html?org/apache/olingo/client/api/communication/response/AsyncResponseWrapper.html" target="_top">Frames</a></li> | |
| <li><a href="AsyncResponseWrapper.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 © 2013–2018 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> | |
| </body> | |
| </html> |