Google Git
Sign in
apache / olingo-site / refs/heads/preview/release-staging / . / output / javadoc / odata4 / org / apache / olingo / client / api / communication / request / ODataBatchableRequest.html
blob: 6ccbc444a31b2a0b0b42ec9adfbc575cc17096e1 [file] [log] [blame]
<!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:32 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ODataBatchableRequest (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="ODataBatchableRequest (Olingo-OData 4.5.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":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/ODataBatchableRequest.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/request/ODataBasicRequest.html" title="interface in org.apache.olingo.client.api.communication.request"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataPayloadManager.html" title="interface in org.apache.olingo.client.api.communication.request"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/olingo/client/api/communication/request/ODataBatchableRequest.html" target="_top">Frames</a></li>
<li><a href="ODataBatchableRequest.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.request</div>
<h2 title="Interface ODataBatchableRequest" class="title">Interface ODataBatchableRequest</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataRequest.html" title="interface in org.apache.olingo.client.api.communication.request">ODataRequest</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../../../org/apache/olingo/client/api/communication/request/retrieve/EdmMetadataRequest.html" title="interface in org.apache.olingo.client.api.communication.request.retrieve">EdmMetadataRequest</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/cud/ODataDeleteRequest.html" title="interface in org.apache.olingo.client.api.communication.request.cud">ODataDeleteRequest</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/retrieve/ODataDeltaRequest.html" title="interface in org.apache.olingo.client.api.communication.request.retrieve">ODataDeltaRequest</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/cud/ODataEntityCreateRequest.html" title="interface in org.apache.olingo.client.api.communication.request.cud">ODataEntityCreateRequest</a>&lt;E&gt;, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/retrieve/ODataEntityRequest.html" title="interface in org.apache.olingo.client.api.communication.request.retrieve">ODataEntityRequest</a>&lt;E&gt;, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/retrieve/ODataEntitySetIteratorRequest.html" title="interface in org.apache.olingo.client.api.communication.request.retrieve">ODataEntitySetIteratorRequest</a>&lt;ES,E&gt;, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/retrieve/ODataEntitySetRequest.html" title="interface in org.apache.olingo.client.api.communication.request.retrieve">ODataEntitySetRequest</a>&lt;ES&gt;, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/cud/ODataEntityUpdateRequest.html" title="interface in org.apache.olingo.client.api.communication.request.cud">ODataEntityUpdateRequest</a>&lt;E&gt;, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/streamed/ODataMediaEntityCreateRequest.html" title="interface in org.apache.olingo.client.api.communication.request.streamed">ODataMediaEntityCreateRequest</a>&lt;E&gt;, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/streamed/ODataMediaEntityUpdateRequest.html" title="interface in org.apache.olingo.client.api.communication.request.streamed">ODataMediaEntityUpdateRequest</a>&lt;E&gt;, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/retrieve/ODataMediaRequest.html" title="interface in org.apache.olingo.client.api.communication.request.retrieve">ODataMediaRequest</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/retrieve/ODataPropertyRequest.html" title="interface in org.apache.olingo.client.api.communication.request.retrieve">ODataPropertyRequest</a>&lt;T&gt;, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/cud/ODataPropertyUpdateRequest.html" title="interface in org.apache.olingo.client.api.communication.request.cud">ODataPropertyUpdateRequest</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/cud/ODataReferenceAddingRequest.html" title="interface in org.apache.olingo.client.api.communication.request.cud">ODataReferenceAddingRequest</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/retrieve/ODataRetrieveRequest.html" title="interface in org.apache.olingo.client.api.communication.request.retrieve">ODataRetrieveRequest</a>&lt;T&gt;, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/retrieve/ODataServiceDocumentRequest.html" title="interface in org.apache.olingo.client.api.communication.request.retrieve">ODataServiceDocumentRequest</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/streamed/ODataStreamUpdateRequest.html" title="interface in org.apache.olingo.client.api.communication.request.streamed">ODataStreamUpdateRequest</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/retrieve/ODataValueRequest.html" title="interface in org.apache.olingo.client.api.communication.request.retrieve">ODataValueRequest</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/cud/ODataValueUpdateRequest.html" title="interface in org.apache.olingo.client.api.communication.request.cud">ODataValueUpdateRequest</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/retrieve/XMLMetadataRequest.html" title="interface in org.apache.olingo.client.api.communication.request.retrieve">XMLMetadataRequest</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ODataBatchableRequest</span>
extends <a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataRequest.html" title="interface in org.apache.olingo.client.api.communication.request">ODataRequest</a></pre>
<div class="block">Object request that can be sent embedded into a batch request.</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="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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataBatchableRequest.html#batch-org.apache.olingo.client.api.communication.request.batch.ODataBatchRequest-">batch</a></span>(<a href="../../../../../../../org/apache/olingo/client/api/communication/request/batch/ODataBatchRequest.html" title="interface in org.apache.olingo.client.api.communication.request.batch">ODataBatchRequest</a>&nbsp;req)</code>
<div class="block">Writes (and consume) the request onto the given batch stream.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataBatchableRequest.html#batch-org.apache.olingo.client.api.communication.request.batch.ODataBatchRequest-java.lang.String-">batch</a></span>(<a href="../../../../../../../org/apache/olingo/client/api/communication/request/batch/ODataBatchRequest.html" title="interface in org.apache.olingo.client.api.communication.request.batch">ODataBatchRequest</a>&nbsp;req,
<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>&nbsp;contentId)</code>
<div class="block">Writes (and consume) the request onto the given batch stream.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.olingo.client.api.communication.request.ODataRequest">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.olingo.client.api.communication.request.<a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataRequest.html" title="interface in org.apache.olingo.client.api.communication.request">ODataRequest</a></h3>
<code><a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataRequest.html#addCustomHeader-java.lang.String-java.lang.String-">addCustomHeader</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataRequest.html#getAccept--">getAccept</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataRequest.html#getContentType--">getContentType</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataRequest.html#getHeader-java.lang.String-">getHeader</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataRequest.html#getHeaderNames--">getHeaderNames</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataRequest.html#getIfMatch--">getIfMatch</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataRequest.html#getIfNoneMatch--">getIfNoneMatch</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataRequest.html#getMethod--">getMethod</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataRequest.html#getPrefer--">getPrefer</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataRequest.html#getURI--">getURI</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataRequest.html#rawExecute--">rawExecute</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataRequest.html#setAccept-java.lang.String-">setAccept</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataRequest.html#setContentType-java.lang.String-">setContentType</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataRequest.html#setIfMatch-java.lang.String-">setIfMatch</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataRequest.html#setIfNoneMatch-java.lang.String-">setIfNoneMatch</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataRequest.html#setPrefer-java.lang.String-">setPrefer</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataRequest.html#setURI-java.net.URI-">setURI</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataRequest.html#setXHTTPMethod-java.lang.String-">setXHTTPMethod</a>, <a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataRequest.html#toByteArray--">toByteArray</a></code></li>
</ul>
</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="batch-org.apache.olingo.client.api.communication.request.batch.ODataBatchRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>batch</h4>
<pre>void&nbsp;batch(<a href="../../../../../../../org/apache/olingo/client/api/communication/request/batch/ODataBatchRequest.html" title="interface in org.apache.olingo.client.api.communication.request.batch">ODataBatchRequest</a>&nbsp;req)</pre>
<div class="block">Writes (and consume) the request onto the given batch stream.
<p>
Please note that this method will consume the request (execution won't be possible anymore).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>req</code> - destination batch request.</dd>
</dl>
</li>
</ul>
<a name="batch-org.apache.olingo.client.api.communication.request.batch.ODataBatchRequest-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>batch</h4>
<pre>void&nbsp;batch(<a href="../../../../../../../org/apache/olingo/client/api/communication/request/batch/ODataBatchRequest.html" title="interface in org.apache.olingo.client.api.communication.request.batch">ODataBatchRequest</a>&nbsp;req,
<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>&nbsp;contentId)</pre>
<div class="block">Writes (and consume) the request onto the given batch stream.
<p>
Please note that this method will consume the request (execution won't be possible anymore).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>req</code> - destination batch request.</dd>
<dd><code>contentId</code> - ContentId header value to be added to the serialization. Use this in case of changeset items.</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/ODataBatchableRequest.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/request/ODataBasicRequest.html" title="interface in org.apache.olingo.client.api.communication.request"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/olingo/client/api/communication/request/ODataPayloadManager.html" title="interface in org.apache.olingo.client.api.communication.request"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/olingo/client/api/communication/request/ODataBatchableRequest.html" target="_top">Frames</a></li>
<li><a href="ODataBatchableRequest.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2013&#x2013;2018 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>