Google Git
Sign in
apache / olingo-site / refs/heads/preview/4.9.0-release-staging / . / output / javadoc / odata2 / org / apache / olingo / odata2 / api / processor / ODataProcessor.html
blob: 99bb19ff67b364abd023ff2dc65a9d7bd6974346 [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:21 CET 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ODataProcessor (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="ODataProcessor (olingo-odata2-parent 2.0.10 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/ODataProcessor.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/processor/ODataErrorContext.html" title="class in org.apache.olingo.odata2.api.processor"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataRequest.html" title="class in org.apache.olingo.odata2.api.processor"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/odata2/api/processor/ODataProcessor.html" target="_top">Frames</a></li>
<li><a href="ODataProcessor.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.api.processor</div>
<h2 title="Interface ODataProcessor" class="title">Interface ODataProcessor</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../../org/apache/olingo/odata2/api/processor/part/BatchProcessor.html" title="interface in org.apache.olingo.odata2.api.processor.part">BatchProcessor</a>, <a href="../../../../../../org/apache/olingo/odata2/api/processor/part/EntityComplexPropertyProcessor.html" title="interface in org.apache.olingo.odata2.api.processor.part">EntityComplexPropertyProcessor</a>, <a href="../../../../../../org/apache/olingo/odata2/api/processor/part/EntityLinkProcessor.html" title="interface in org.apache.olingo.odata2.api.processor.part">EntityLinkProcessor</a>, <a href="../../../../../../org/apache/olingo/odata2/api/processor/part/EntityLinksProcessor.html" title="interface in org.apache.olingo.odata2.api.processor.part">EntityLinksProcessor</a>, <a href="../../../../../../org/apache/olingo/odata2/api/processor/part/EntityMediaProcessor.html" title="interface in org.apache.olingo.odata2.api.processor.part">EntityMediaProcessor</a>, <a href="../../../../../../org/apache/olingo/odata2/api/processor/part/EntityProcessor.html" title="interface in org.apache.olingo.odata2.api.processor.part">EntityProcessor</a>, <a href="../../../../../../org/apache/olingo/odata2/api/processor/part/EntitySetProcessor.html" title="interface in org.apache.olingo.odata2.api.processor.part">EntitySetProcessor</a>, <a href="../../../../../../org/apache/olingo/odata2/api/processor/part/EntitySimplePropertyProcessor.html" title="interface in org.apache.olingo.odata2.api.processor.part">EntitySimplePropertyProcessor</a>, <a href="../../../../../../org/apache/olingo/odata2/api/processor/part/EntitySimplePropertyValueProcessor.html" title="interface in org.apache.olingo.odata2.api.processor.part">EntitySimplePropertyValueProcessor</a>, <a href="../../../../../../org/apache/olingo/odata2/api/processor/part/FunctionImportProcessor.html" title="interface in org.apache.olingo.odata2.api.processor.part">FunctionImportProcessor</a>, <a href="../../../../../../org/apache/olingo/odata2/api/processor/part/FunctionImportValueProcessor.html" title="interface in org.apache.olingo.odata2.api.processor.part">FunctionImportValueProcessor</a>, <a href="../../../../../../org/apache/olingo/odata2/api/processor/part/MetadataProcessor.html" title="interface in org.apache.olingo.odata2.api.processor.part">MetadataProcessor</a>, <a href="../../../../../../org/apache/olingo/odata2/api/processor/part/ServiceDocumentProcessor.html" title="interface in org.apache.olingo.odata2.api.processor.part">ServiceDocumentProcessor</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/olingo/odata2/jpa/processor/ref/util/CustomODataJPAProcessor.html" title="class in org.apache.olingo.odata2.jpa.processor.ref.util">CustomODataJPAProcessor</a>, <a href="../../../../../../org/apache/olingo/odata2/ref/processor/ListsProcessor.html" title="class in org.apache.olingo.odata2.ref.processor">ListsProcessor</a>, <a href="../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPADefaultProcessor.html" title="class in org.apache.olingo.odata2.jpa.processor.api">ODataJPADefaultProcessor</a>, <a href="../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAProcessor.html" title="class in org.apache.olingo.odata2.jpa.processor.api">ODataJPAProcessor</a>, <a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataSingleProcessor.html" title="class in org.apache.olingo.odata2.api.processor">ODataSingleProcessor</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ODataProcessor</span></pre>
<div class="block">An <code>ODataProcessor</code> is the root interface for processor implementation.
A processor handles OData requests like reading or writing entities. All possible
actions are defined in the <a href="../../../../../../org/apache/olingo/odata2/api/processor/feature/package-summary.html"><code>org.apache.olingo.odata2.api.processor.feature</code></a> package.</div>
<dl>
<dt><span class="simpleTagLabel">Do not implement this interface or derive from class.</span></dt>
</dl>
</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/ODataContext.html" title="interface in org.apache.olingo.odata2.api.processor">ODataContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataProcessor.html#getContext--">getContext</a></span>()</code>&nbsp;</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/odata2/api/processor/ODataProcessor.html#setContext-org.apache.olingo.odata2.api.processor.ODataContext-">setContext</a></span>(<a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataContext.html" title="interface in org.apache.olingo.odata2.api.processor">ODataContext</a>&nbsp;context)</code>&nbsp;</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="setContext-org.apache.olingo.odata2.api.processor.ODataContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setContext</h4>
<pre>void&nbsp;setContext(<a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataContext.html" title="interface in org.apache.olingo.odata2.api.processor">ODataContext</a>&nbsp;context)
throws <a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataException.html" title="class in org.apache.olingo.odata2.api.exception">ODataException</a></pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - A request context object which is usually injected by the OData library itself.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataException.html" title="class in org.apache.olingo.odata2.api.exception">ODataException</a></code></dd>
</dl>
</li>
</ul>
<a name="getContext--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getContext</h4>
<pre><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataContext.html" title="interface in org.apache.olingo.odata2.api.processor">ODataContext</a>&nbsp;getContext()
throws <a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataException.html" title="class in org.apache.olingo.odata2.api.exception">ODataException</a></pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A request context object.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataException.html" title="class in org.apache.olingo.odata2.api.exception">ODataException</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/ODataProcessor.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/processor/ODataErrorContext.html" title="class in org.apache.olingo.odata2.api.processor"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataRequest.html" title="class in org.apache.olingo.odata2.api.processor"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/odata2/api/processor/ODataProcessor.html" target="_top">Frames</a></li>
<li><a href="ODataProcessor.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>