blob: b887118e36c104b61c0beb9dea37851462b158ef [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>org.apache.olingo.odata2.api.ep (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="org.apache.olingo.odata2.api.ep (olingo-odata2-parent 2.0.10 API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/api/edm/provider/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/olingo/odata2/api/ep/callback/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/odata2/api/ep/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.olingo.odata2.api.ep</h1>
<div class="docSummary">
<div class="block">Entity Provider</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/ep/EntityProvider.EntityProviderInterface.html" title="interface in org.apache.olingo.odata2.api.ep">EntityProvider.EntityProviderInterface</a></td>
<td class="colLast">
<div class="block">(Internal) interface for all <a href="../../../../../../org/apache/olingo/odata2/api/ep/EntityProvider.html" title="class in org.apache.olingo.odata2.api.ep"><code>EntityProvider</code></a> necessary <b>read</b> and <b>write</b> methods for accessing
entities defined in an <code>Entity Data Model</code>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/ep/EntityProvider.html" title="class in org.apache.olingo.odata2.api.ep">EntityProvider</a></td>
<td class="colLast">
<div class="block">Entity Provider</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/ep/EntityProviderBatchProperties.html" title="class in org.apache.olingo.odata2.api.ep">EntityProviderBatchProperties</a></td>
<td class="colLast">
<div class="block">The <a href="../../../../../../org/apache/olingo/odata2/api/ep/EntityProviderBatchProperties.html" title="class in org.apache.olingo.odata2.api.ep"><code>EntityProviderBatchProperties</code></a> contains necessary informations to parse a Batch Request body.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/ep/EntityProviderBatchProperties.EntityProviderBatchPropertiesBuilder.html" title="class in org.apache.olingo.odata2.api.ep">EntityProviderBatchProperties.EntityProviderBatchPropertiesBuilder</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/ep/EntityProviderReadProperties.html" title="class in org.apache.olingo.odata2.api.ep">EntityProviderReadProperties</a></td>
<td class="colLast">
<div class="block">The <a href="../../../../../../org/apache/olingo/odata2/api/ep/EntityProviderReadProperties.html" title="class in org.apache.olingo.odata2.api.ep"><code>EntityProviderReadProperties</code></a> contains all necessary settings
to read an entity with the <a href="../../../../../../org/apache/olingo/odata2/api/ep/EntityProvider.html" title="class in org.apache.olingo.odata2.api.ep"><code>EntityProvider</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/ep/EntityProviderReadProperties.EntityProviderReadPropertiesBuilder.html" title="class in org.apache.olingo.odata2.api.ep">EntityProviderReadProperties.EntityProviderReadPropertiesBuilder</a></td>
<td class="colLast">
<div class="block">Builder for <a href="../../../../../../org/apache/olingo/odata2/api/ep/EntityProviderReadProperties.html" title="class in org.apache.olingo.odata2.api.ep"><code>EntityProviderReadProperties</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/ep/EntityProviderWriteProperties.html" title="class in org.apache.olingo.odata2.api.ep">EntityProviderWriteProperties</a></td>
<td class="colLast">
<div class="block"><a href="../../../../../../org/apache/olingo/odata2/api/ep/EntityProviderWriteProperties.html" title="class in org.apache.olingo.odata2.api.ep"><code>EntityProviderWriteProperties</code></a> contains all additional properties which are necessary to <b>write
(serialize)</b> an <a href="../../../../../../org/apache/olingo/odata2/api/ep/entry/ODataEntry.html" title="interface in org.apache.olingo.odata2.api.ep.entry"><code>ODataEntry</code></a> into an specific format (e.g.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/ep/EntityProviderWriteProperties.ODataEntityProviderPropertiesBuilder.html" title="class in org.apache.olingo.odata2.api.ep">EntityProviderWriteProperties.ODataEntityProviderPropertiesBuilder</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/ep/EntityProviderException.html" title="class in org.apache.olingo.odata2.api.ep">EntityProviderException</a></td>
<td class="colLast">
<div class="block">An <a href="../../../../../../org/apache/olingo/odata2/api/ep/EntityProviderException.html" title="class in org.apache.olingo.odata2.api.ep"><code>EntityProviderException</code></a> is the base exception for all <code>EntityProvider</code> related exceptions.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.olingo.odata2.api.ep Description">Package org.apache.olingo.odata2.api.ep Description</h2>
<div class="block">Entity Provider<p>
The <b>org.apache.olingo.odata2.api.ep</b> package contains all classes related and necessary to provide an
<a href="../../../../../../org/apache/olingo/odata2/api/ep/EntityProvider.html" title="class in org.apache.olingo.odata2.api.ep"><code>EntityProvider</code></a>.
<p>
An <a href="../../../../../../org/apache/olingo/odata2/api/ep/EntityProvider.html" title="class in org.apache.olingo.odata2.api.ep"><code>EntityProvider</code></a> provides all necessary <b>read</b> and <b>write</b> methods
for accessing
the entities defined in an <code>Entity Data Model</code>.
Therefore this library provides (in its <code>core</code> packages) as convenience basic
<a href="../../../../../../org/apache/olingo/odata2/api/ep/EntityProvider.html" title="class in org.apache.olingo.odata2.api.ep"><code>EntityProvider</code></a> for accessing entities in the <b>XML</b> and <b>JSON</b>
format.
<p>
For support of additional formats it is recommended to handle those directly within an implementation of a
<code>ODataProcessor</code> (it is possible but <b>not recommended</b> to implement an own
<a href="../../../../../../org/apache/olingo/odata2/api/ep/EntityProvider.html" title="class in org.apache.olingo.odata2.api.ep"><code>EntityProvider</code></a> for support of additional formats).</div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/api/edm/provider/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/olingo/odata2/api/ep/callback/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/odata2/api/ep/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<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>