blob: dcc247de16e9bb20835a14205173dc730bb756a9 [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 Wed Dec 06 14:36:23 CET 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ODataJPAResponseBuilder (olingo-odata2-parent 2.0.10 API)</title>
<meta name="date" content="2017-12-06">
<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="ODataJPAResponseBuilder (olingo-odata2-parent 2.0.10 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":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/ODataJPAResponseBuilder.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/odata2/jpa/processor/api/ODataJPAQueryExtensionEntityListener.html" title="class in org.apache.olingo.odata2.jpa.processor.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAServiceFactory.html" title="class in org.apache.olingo.odata2.jpa.processor.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/olingo/odata2/jpa/processor/api/ODataJPAResponseBuilder.html" target="_top">Frames</a></li>
<li><a href="ODataJPAResponseBuilder.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.odata2.jpa.processor.api</div>
<h2 title="Interface ODataJPAResponseBuilder" class="title">Interface ODataJPAResponseBuilder</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ODataJPAResponseBuilder</span></pre>
<div class="block">The interface provides methods for building an OData response from a JPA Entity.
Implement this interface for building an OData response from a JPA 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><a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAResponseBuilder.html#build-org.apache.olingo.odata2.api.uri.info.DeleteUriInfo-java.lang.Object-">build</a></span>(<a href="../../../../../../../org/apache/olingo/odata2/api/uri/info/DeleteUriInfo.html" title="interface in org.apache.olingo.odata2.api.uri.info">DeleteUriInfo</a>&nbsp;deleteUriInfo,
<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>&nbsp;deletedObject)</code>
<div class="block">The method builds an OData response for an OData Delete Request from a deleted JPA Entity</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAResponseBuilder.html#build-org.apache.olingo.odata2.api.uri.info.GetEntityLinkUriInfo-java.lang.Object-java.lang.String-">build</a></span>(<a href="../../../../../../../org/apache/olingo/odata2/api/uri/info/GetEntityLinkUriInfo.html" title="interface in org.apache.olingo.odata2.api.uri.info">GetEntityLinkUriInfo</a>&nbsp;readLinkUriInfo,
<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>&nbsp;jpaEntity,
<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;contentType)</code>
<div class="block">The method builds an OData response for an OData Read Link Request from a read JPA Entity and its related JPA
Entities.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAResponseBuilder.html#build-org.apache.olingo.odata2.api.uri.info.GetEntitySetLinksUriInfo-java.util.List-java.lang.String-">build</a></span>(<a href="../../../../../../../org/apache/olingo/odata2/api/uri/info/GetEntitySetLinksUriInfo.html" title="interface in org.apache.olingo.odata2.api.uri.info">GetEntitySetLinksUriInfo</a>&nbsp;queryLinkUriInfo,
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;jpaEntity,
<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;contentType)</code>
<div class="block">The method builds an OData response for an OData Query Link Request from a queried JPA Entity and its related JPA
Entities.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAResponseBuilder.html#build-org.apache.olingo.odata2.api.uri.info.GetEntitySetUriInfo-java.util.List-java.lang.String-">build</a></span>(<a href="../../../../../../../org/apache/olingo/odata2/api/uri/info/GetEntitySetUriInfo.html" title="interface in org.apache.olingo.odata2.api.uri.info">GetEntitySetUriInfo</a>&nbsp;queryUriInfo,
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;jpaEntities,
<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;contentType)</code>
<div class="block">The method builds an OData response for an OData Query Request from a queried list of JPA Entities.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAResponseBuilder.html#build-org.apache.olingo.odata2.api.uri.info.GetEntityUriInfo-java.lang.Object-java.lang.String-">build</a></span>(<a href="../../../../../../../org/apache/olingo/odata2/api/uri/info/GetEntityUriInfo.html" title="interface in org.apache.olingo.odata2.api.uri.info">GetEntityUriInfo</a>&nbsp;readUriInfo,
<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>&nbsp;jpaEntity,
<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;contentType)</code>
<div class="block">The method builds an OData response for an OData Read Request from a read JPA Entity</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAResponseBuilder.html#build-org.apache.olingo.odata2.api.uri.info.GetFunctionImportUriInfo-java.util.List-java.lang.String-">build</a></span>(<a href="../../../../../../../org/apache/olingo/odata2/api/uri/info/GetFunctionImportUriInfo.html" title="interface in org.apache.olingo.odata2.api.uri.info">GetFunctionImportUriInfo</a>&nbsp;functionImportUriInfo,
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;resultList,
<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;contentType)</code>
<div class="block">The method builds an OData response for an OData function Import Request from a registered processor method's
return parameter.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAResponseBuilder.html#build-org.apache.olingo.odata2.api.uri.info.GetFunctionImportUriInfo-java.lang.Object-">build</a></span>(<a href="../../../../../../../org/apache/olingo/odata2/api/uri/info/GetFunctionImportUriInfo.html" title="interface in org.apache.olingo.odata2.api.uri.info">GetFunctionImportUriInfo</a>&nbsp;functionImportUriInfo,
<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>&nbsp;result)</code>
<div class="block">The method builds an OData response for an OData function Import Request from a registered processor method's
return parameter.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAResponseBuilder.html#build-long-">build</a></span>(long&nbsp;jpaEntityCount)</code>
<div class="block">The method builds an OData response from a count representing total number of JPA Entities</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAResponseBuilder.html#build-org.apache.olingo.odata2.api.uri.info.PostUriInfo-java.lang.Object-java.lang.String-">build</a></span>(<a href="../../../../../../../org/apache/olingo/odata2/api/uri/info/PostUriInfo.html" title="interface in org.apache.olingo.odata2.api.uri.info">PostUriInfo</a>&nbsp;postUriInfo,
<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>&nbsp;createdObject,
<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;contentType)</code>
<div class="block">The method builds an OData response for an OData Create Request from a created JPA entity.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAResponseBuilder.html#build-org.apache.olingo.odata2.api.uri.info.PutMergePatchUriInfo-java.lang.Object-">build</a></span>(<a href="../../../../../../../org/apache/olingo/odata2/api/uri/info/PutMergePatchUriInfo.html" title="interface in org.apache.olingo.odata2.api.uri.info">PutMergePatchUriInfo</a>&nbsp;putUriInfo,
<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>&nbsp;updatedObject)</code>
<div class="block">The method builds an OData response for an OData Update Request from an updated JPA Entity</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="build-org.apache.olingo.odata2.api.uri.info.GetEntitySetUriInfo-java.util.List-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre><a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse</a>&nbsp;build(<a href="../../../../../../../org/apache/olingo/odata2/api/uri/info/GetEntitySetUriInfo.html" title="interface in org.apache.olingo.odata2.api.uri.info">GetEntitySetUriInfo</a>&nbsp;queryUriInfo,
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;jpaEntities,
<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;contentType)
throws <a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</a></pre>
<div class="block">The method builds an OData response for an OData Query Request from a queried list of JPA Entities.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>queryUriInfo</code> - is an information about the request URI</dd>
<dd><code>jpaEntities</code> - is an empty or non empty list of queried instances of JPA Entities</dd>
<dd><code>contentType</code> - of the response</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance of type <a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor"><code>ODataResponse</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</a></code></dd>
</dl>
</li>
</ul>
<a name="build-org.apache.olingo.odata2.api.uri.info.GetEntityUriInfo-java.lang.Object-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre><a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse</a>&nbsp;build(<a href="../../../../../../../org/apache/olingo/odata2/api/uri/info/GetEntityUriInfo.html" title="interface in org.apache.olingo.odata2.api.uri.info">GetEntityUriInfo</a>&nbsp;readUriInfo,
<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>&nbsp;jpaEntity,
<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;contentType)
throws <a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</a>,
<a href="../../../../../../../org/apache/olingo/odata2/api/exception/ODataNotFoundException.html" title="class in org.apache.olingo.odata2.api.exception">ODataNotFoundException</a></pre>
<div class="block">The method builds an OData response for an OData Read Request from a read JPA Entity</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>readUriInfo</code> - is an information about the request URI</dd>
<dd><code>jpaEntity</code> - is a null or non null instances of read JPA Entity</dd>
<dd><code>contentType</code> - of the response</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance of type <a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor"><code>ODataResponse</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</a></code></dd>
<dd><code><a href="../../../../../../../org/apache/olingo/odata2/api/exception/ODataNotFoundException.html" title="class in org.apache.olingo.odata2.api.exception">ODataNotFoundException</a></code></dd>
</dl>
</li>
</ul>
<a name="build-org.apache.olingo.odata2.api.uri.info.PostUriInfo-java.lang.Object-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre><a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse</a>&nbsp;build(<a href="../../../../../../../org/apache/olingo/odata2/api/uri/info/PostUriInfo.html" title="interface in org.apache.olingo.odata2.api.uri.info">PostUriInfo</a>&nbsp;postUriInfo,
<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>&nbsp;createdObject,
<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;contentType)
throws <a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</a>,
<a href="../../../../../../../org/apache/olingo/odata2/api/exception/ODataNotFoundException.html" title="class in org.apache.olingo.odata2.api.exception">ODataNotFoundException</a></pre>
<div class="block">The method builds an OData response for an OData Create Request from a created JPA entity.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>postUriInfo</code> - is an information about the request URI</dd>
<dd><code>createdObject</code> - is a null or non null instances of JPA Entity</dd>
<dd><code>contentType</code> - of the response</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance of type <a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor"><code>ODataResponse</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</a></code></dd>
<dd><code><a href="../../../../../../../org/apache/olingo/odata2/api/exception/ODataNotFoundException.html" title="class in org.apache.olingo.odata2.api.exception">ODataNotFoundException</a></code></dd>
</dl>
</li>
</ul>
<a name="build-org.apache.olingo.odata2.api.uri.info.PutMergePatchUriInfo-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre><a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse</a>&nbsp;build(<a href="../../../../../../../org/apache/olingo/odata2/api/uri/info/PutMergePatchUriInfo.html" title="interface in org.apache.olingo.odata2.api.uri.info">PutMergePatchUriInfo</a>&nbsp;putUriInfo,
<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>&nbsp;updatedObject)
throws <a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</a>,
<a href="../../../../../../../org/apache/olingo/odata2/api/exception/ODataNotFoundException.html" title="class in org.apache.olingo.odata2.api.exception">ODataNotFoundException</a></pre>
<div class="block">The method builds an OData response for an OData Update Request from an updated JPA Entity</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>putUriInfo</code> - is an information about the request URI</dd>
<dd><code>updatedObject</code> - is an updated instance of JPA Entity</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance of type <a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor"><code>ODataResponse</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</a></code></dd>
<dd><code><a href="../../../../../../../org/apache/olingo/odata2/api/exception/ODataNotFoundException.html" title="class in org.apache.olingo.odata2.api.exception">ODataNotFoundException</a></code></dd>
</dl>
</li>
</ul>
<a name="build-org.apache.olingo.odata2.api.uri.info.DeleteUriInfo-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre><a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse</a>&nbsp;build(<a href="../../../../../../../org/apache/olingo/odata2/api/uri/info/DeleteUriInfo.html" title="interface in org.apache.olingo.odata2.api.uri.info">DeleteUriInfo</a>&nbsp;deleteUriInfo,
<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>&nbsp;deletedObject)
throws <a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</a>,
<a href="../../../../../../../org/apache/olingo/odata2/api/exception/ODataNotFoundException.html" title="class in org.apache.olingo.odata2.api.exception">ODataNotFoundException</a></pre>
<div class="block">The method builds an OData response for an OData Delete Request from a deleted JPA Entity</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>deleteUriInfo</code> - is an information about the request URI</dd>
<dd><code>deletedObject</code> - is an null or non null instance of deleted JPA Entity. Null implies Entity not found.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance of type <a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor"><code>ODataResponse</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</a></code></dd>
<dd><code><a href="../../../../../../../org/apache/olingo/odata2/api/exception/ODataNotFoundException.html" title="class in org.apache.olingo.odata2.api.exception">ODataNotFoundException</a></code></dd>
</dl>
</li>
</ul>
<a name="build-org.apache.olingo.odata2.api.uri.info.GetFunctionImportUriInfo-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre><a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse</a>&nbsp;build(<a href="../../../../../../../org/apache/olingo/odata2/api/uri/info/GetFunctionImportUriInfo.html" title="interface in org.apache.olingo.odata2.api.uri.info">GetFunctionImportUriInfo</a>&nbsp;functionImportUriInfo,
<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>&nbsp;result)
throws <a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</a></pre>
<div class="block">The method builds an OData response for an OData function Import Request from a registered processor method's
return parameter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>functionImportUriInfo</code> - is an information about the request URI</dd>
<dd><code>result</code> - is a method's return parameter</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance of type <a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor"><code>ODataResponse</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</a></code></dd>
</dl>
</li>
</ul>
<a name="build-org.apache.olingo.odata2.api.uri.info.GetFunctionImportUriInfo-java.util.List-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre><a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse</a>&nbsp;build(<a href="../../../../../../../org/apache/olingo/odata2/api/uri/info/GetFunctionImportUriInfo.html" title="interface in org.apache.olingo.odata2.api.uri.info">GetFunctionImportUriInfo</a>&nbsp;functionImportUriInfo,
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;resultList,
<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;contentType)
throws <a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</a>,
<a href="../../../../../../../org/apache/olingo/odata2/api/exception/ODataNotFoundException.html" title="class in org.apache.olingo.odata2.api.exception">ODataNotFoundException</a></pre>
<div class="block">The method builds an OData response for an OData function Import Request from a registered processor method's
return parameter. The return parameter is a collection of objects.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>functionImportUriInfo</code> - is an information about the request URI</dd>
<dd><code>result</code> - is a method's return parameter is a collection of objects.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance of type <a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor"><code>ODataResponse</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</a></code></dd>
<dd><code><a href="../../../../../../../org/apache/olingo/odata2/api/exception/ODataNotFoundException.html" title="class in org.apache.olingo.odata2.api.exception">ODataNotFoundException</a></code></dd>
</dl>
</li>
</ul>
<a name="build-org.apache.olingo.odata2.api.uri.info.GetEntityLinkUriInfo-java.lang.Object-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre><a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse</a>&nbsp;build(<a href="../../../../../../../org/apache/olingo/odata2/api/uri/info/GetEntityLinkUriInfo.html" title="interface in org.apache.olingo.odata2.api.uri.info">GetEntityLinkUriInfo</a>&nbsp;readLinkUriInfo,
<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>&nbsp;jpaEntity,
<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;contentType)
throws <a href="../../../../../../../org/apache/olingo/odata2/api/exception/ODataNotFoundException.html" title="class in org.apache.olingo.odata2.api.exception">ODataNotFoundException</a>,
<a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</a></pre>
<div class="block">The method builds an OData response for an OData Read Link Request from a read JPA Entity and its related JPA
Entities.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>readLinkUriInfo</code> - is an information about the request URI</dd>
<dd><code>jpaEntity</code> - is a null or non null read JPA Entity and its related JPA Entities.</dd>
<dd><code>contentType</code> - of the response</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance of type <a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor"><code>ODataResponse</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/olingo/odata2/api/exception/ODataNotFoundException.html" title="class in org.apache.olingo.odata2.api.exception">ODataNotFoundException</a></code></dd>
<dd><code><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</a></code></dd>
</dl>
</li>
</ul>
<a name="build-org.apache.olingo.odata2.api.uri.info.GetEntitySetLinksUriInfo-java.util.List-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre><a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse</a>&nbsp;build(<a href="../../../../../../../org/apache/olingo/odata2/api/uri/info/GetEntitySetLinksUriInfo.html" title="interface in org.apache.olingo.odata2.api.uri.info">GetEntitySetLinksUriInfo</a>&nbsp;queryLinkUriInfo,
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;jpaEntity,
<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;contentType)
throws <a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</a></pre>
<div class="block">The method builds an OData response for an OData Query Link Request from a queried JPA Entity and its related JPA
Entities.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>queryLinkUriInfo</code> - is an information about the request URI</dd>
<dd><code>jpaEntity</code> - is an empty or non empty list of queried JPA Entities</dd>
<dd><code>contentType</code> - of the response</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance of type <a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor"><code>ODataResponse</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</a></code></dd>
</dl>
</li>
</ul>
<a name="build-long-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>build</h4>
<pre><a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse</a>&nbsp;build(long&nbsp;jpaEntityCount)
throws <a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</a></pre>
<div class="block">The method builds an OData response from a count representing total number of JPA Entities</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jpaEntityCount</code> - is the count value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance of type <a href="../../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor"><code>ODataResponse</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/exception/ODataJPARuntimeException.html" title="class in org.apache.olingo.odata2.jpa.processor.api.exception">ODataJPARuntimeException</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/ODataJPAResponseBuilder.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/odata2/jpa/processor/api/ODataJPAQueryExtensionEntityListener.html" title="class in org.apache.olingo.odata2.jpa.processor.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAServiceFactory.html" title="class in org.apache.olingo.odata2.jpa.processor.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/olingo/odata2/jpa/processor/api/ODataJPAResponseBuilder.html" target="_top">Frames</a></li>
<li><a href="ODataJPAResponseBuilder.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-2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>