Google Git
Sign in
apache / olingo-site / refs/heads/preview/release-staging / . / output / javadoc / odata4 / org / apache / olingo / server / api / processor / ComplexProcessor.html
blob: 7a8d3bdcbcf90f53974a9e2384675647d1440213 [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:34 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ComplexProcessor (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="ComplexProcessor (Olingo-OData 4.5.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":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/ComplexProcessor.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/processor/ComplexCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/olingo/server/api/processor/CountComplexCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/server/api/processor/ComplexProcessor.html" target="_top">Frames</a></li>
<li><a href="ComplexProcessor.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.server.api.processor</div>
<h2 title="Interface ComplexProcessor" class="title">Interface ComplexProcessor</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/server/api/processor/Processor.html" title="interface in org.apache.olingo.server.api.processor">Processor</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ComplexProcessor</span>
extends <a href="../../../../../../org/apache/olingo/server/api/processor/Processor.html" title="interface in org.apache.olingo.server.api.processor">Processor</a></pre>
<div class="block">Processor interface for handling an instance of a complex type, e.g., a complex property of an entity.</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/server/api/processor/ComplexProcessor.html#deleteComplex-org.apache.olingo.server.api.ODataRequest-org.apache.olingo.server.api.ODataResponse-org.apache.olingo.server.api.uri.UriInfo-">deleteComplex</a></span>(<a href="../../../../../../org/apache/olingo/server/api/ODataRequest.html" title="class in org.apache.olingo.server.api">ODataRequest</a>&nbsp;request,
<a href="../../../../../../org/apache/olingo/server/api/ODataResponse.html" title="class in org.apache.olingo.server.api">ODataResponse</a>&nbsp;response,
<a href="../../../../../../org/apache/olingo/server/api/uri/UriInfo.html" title="interface in org.apache.olingo.server.api.uri">UriInfo</a>&nbsp;uriInfo)</code>
<div class="block">Deletes complex-type value from an entity and puts the status into the response.</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/server/api/processor/ComplexProcessor.html#readComplex-org.apache.olingo.server.api.ODataRequest-org.apache.olingo.server.api.ODataResponse-org.apache.olingo.server.api.uri.UriInfo-org.apache.olingo.commons.api.format.ContentType-">readComplex</a></span>(<a href="../../../../../../org/apache/olingo/server/api/ODataRequest.html" title="class in org.apache.olingo.server.api">ODataRequest</a>&nbsp;request,
<a href="../../../../../../org/apache/olingo/server/api/ODataResponse.html" title="class in org.apache.olingo.server.api">ODataResponse</a>&nbsp;response,
<a href="../../../../../../org/apache/olingo/server/api/uri/UriInfo.html" title="interface in org.apache.olingo.server.api.uri">UriInfo</a>&nbsp;uriInfo,
<a href="../../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;responseFormat)</code>
<div class="block">Reads complex-type instance.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/processor/ComplexProcessor.html#updateComplex-org.apache.olingo.server.api.ODataRequest-org.apache.olingo.server.api.ODataResponse-org.apache.olingo.server.api.uri.UriInfo-org.apache.olingo.commons.api.format.ContentType-org.apache.olingo.commons.api.format.ContentType-">updateComplex</a></span>(<a href="../../../../../../org/apache/olingo/server/api/ODataRequest.html" title="class in org.apache.olingo.server.api">ODataRequest</a>&nbsp;request,
<a href="../../../../../../org/apache/olingo/server/api/ODataResponse.html" title="class in org.apache.olingo.server.api">ODataResponse</a>&nbsp;response,
<a href="../../../../../../org/apache/olingo/server/api/uri/UriInfo.html" title="interface in org.apache.olingo.server.api.uri">UriInfo</a>&nbsp;uriInfo,
<a href="../../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;requestFormat,
<a href="../../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;responseFormat)</code>
<div class="block">Update complex-type instance with send data in the persistence and
puts content, status, and Location into the response.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.olingo.server.api.processor.Processor">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.olingo.server.api.processor.<a href="../../../../../../org/apache/olingo/server/api/processor/Processor.html" title="interface in org.apache.olingo.server.api.processor">Processor</a></h3>
<code><a href="../../../../../../org/apache/olingo/server/api/processor/Processor.html#init-org.apache.olingo.server.api.OData-org.apache.olingo.server.api.ServiceMetadata-">init</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="readComplex-org.apache.olingo.server.api.ODataRequest-org.apache.olingo.server.api.ODataResponse-org.apache.olingo.server.api.uri.UriInfo-org.apache.olingo.commons.api.format.ContentType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readComplex</h4>
<pre>void&nbsp;readComplex(<a href="../../../../../../org/apache/olingo/server/api/ODataRequest.html" title="class in org.apache.olingo.server.api">ODataRequest</a>&nbsp;request,
<a href="../../../../../../org/apache/olingo/server/api/ODataResponse.html" title="class in org.apache.olingo.server.api">ODataResponse</a>&nbsp;response,
<a href="../../../../../../org/apache/olingo/server/api/uri/UriInfo.html" title="interface in org.apache.olingo.server.api.uri">UriInfo</a>&nbsp;uriInfo,
<a href="../../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;responseFormat)
throws <a href="../../../../../../org/apache/olingo/server/api/ODataApplicationException.html" title="class in org.apache.olingo.server.api">ODataApplicationException</a>,
<a href="../../../../../../org/apache/olingo/server/api/ODataLibraryException.html" title="class in org.apache.olingo.server.api">ODataLibraryException</a></pre>
<div class="block">Reads complex-type instance.
If it is not available, for example due to permissions, the service responds with 404 Not Found.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - OData request object containing raw HTTP information</dd>
<dd><code>response</code> - OData response object for collecting response data</dd>
<dd><code>uriInfo</code> - information of a parsed OData URI</dd>
<dd><code>responseFormat</code> - requested content type after content negotiation</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/olingo/server/api/ODataApplicationException.html" title="class in org.apache.olingo.server.api">ODataApplicationException</a></code> - if the service implementation encounters a failure</dd>
<dd><code><a href="../../../../../../org/apache/olingo/server/api/ODataLibraryException.html" title="class in org.apache.olingo.server.api">ODataLibraryException</a></code></dd>
</dl>
</li>
</ul>
<a name="updateComplex-org.apache.olingo.server.api.ODataRequest-org.apache.olingo.server.api.ODataResponse-org.apache.olingo.server.api.uri.UriInfo-org.apache.olingo.commons.api.format.ContentType-org.apache.olingo.commons.api.format.ContentType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateComplex</h4>
<pre>void&nbsp;updateComplex(<a href="../../../../../../org/apache/olingo/server/api/ODataRequest.html" title="class in org.apache.olingo.server.api">ODataRequest</a>&nbsp;request,
<a href="../../../../../../org/apache/olingo/server/api/ODataResponse.html" title="class in org.apache.olingo.server.api">ODataResponse</a>&nbsp;response,
<a href="../../../../../../org/apache/olingo/server/api/uri/UriInfo.html" title="interface in org.apache.olingo.server.api.uri">UriInfo</a>&nbsp;uriInfo,
<a href="../../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;requestFormat,
<a href="../../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;responseFormat)
throws <a href="../../../../../../org/apache/olingo/server/api/ODataApplicationException.html" title="class in org.apache.olingo.server.api">ODataApplicationException</a>,
<a href="../../../../../../org/apache/olingo/server/api/ODataLibraryException.html" title="class in org.apache.olingo.server.api">ODataLibraryException</a></pre>
<div class="block">Update complex-type instance with send data in the persistence and
puts content, status, and Location into the response.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - OData request object containing raw HTTP information</dd>
<dd><code>response</code> - OData response object for collecting response data</dd>
<dd><code>uriInfo</code> - information of a parsed OData URI</dd>
<dd><code>requestFormat</code> - content type of body sent with request</dd>
<dd><code>responseFormat</code> - requested content type after content negotiation</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/olingo/server/api/ODataApplicationException.html" title="class in org.apache.olingo.server.api">ODataApplicationException</a></code> - if the service implementation encounters a failure</dd>
<dd><code><a href="../../../../../../org/apache/olingo/server/api/ODataLibraryException.html" title="class in org.apache.olingo.server.api">ODataLibraryException</a></code></dd>
</dl>
</li>
</ul>
<a name="deleteComplex-org.apache.olingo.server.api.ODataRequest-org.apache.olingo.server.api.ODataResponse-org.apache.olingo.server.api.uri.UriInfo-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>deleteComplex</h4>
<pre>void&nbsp;deleteComplex(<a href="../../../../../../org/apache/olingo/server/api/ODataRequest.html" title="class in org.apache.olingo.server.api">ODataRequest</a>&nbsp;request,
<a href="../../../../../../org/apache/olingo/server/api/ODataResponse.html" title="class in org.apache.olingo.server.api">ODataResponse</a>&nbsp;response,
<a href="../../../../../../org/apache/olingo/server/api/uri/UriInfo.html" title="interface in org.apache.olingo.server.api.uri">UriInfo</a>&nbsp;uriInfo)
throws <a href="../../../../../../org/apache/olingo/server/api/ODataApplicationException.html" title="class in org.apache.olingo.server.api">ODataApplicationException</a>,
<a href="../../../../../../org/apache/olingo/server/api/ODataLibraryException.html" title="class in org.apache.olingo.server.api">ODataLibraryException</a></pre>
<div class="block">Deletes complex-type value from an entity and puts the status into the response.
Deletion for complex-type values is equal to
set the value to <code>NULL</code> (see chapter "11.4.9.2 Set a Value to Null")</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - OData request object containing raw HTTP information</dd>
<dd><code>response</code> - OData response object for collecting response data</dd>
<dd><code>uriInfo</code> - information of a parsed OData URI</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/olingo/server/api/ODataApplicationException.html" title="class in org.apache.olingo.server.api">ODataApplicationException</a></code> - if the service implementation encounters a failure</dd>
<dd><code><a href="../../../../../../org/apache/olingo/server/api/ODataLibraryException.html" title="class in org.apache.olingo.server.api">ODataLibraryException</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/ComplexProcessor.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/processor/ComplexCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/olingo/server/api/processor/CountComplexCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/server/api/processor/ComplexProcessor.html" target="_top">Frames</a></li>
<li><a href="ComplexProcessor.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>