blob: c6d873a6b360c0e4b19f8f39cc8ea86b38d91980 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.10) on Mon Dec 05 10:27:04 MSK 2022 -->
<title>OperationObserver (cayenne-doc: Cayenne Documentation 4.2.RC2 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-12-05">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="OperationObserver (cayenne-doc: Cayenne Documentation 4.2.RC2 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":50,"i4":6,"i5":6,"i6":6,"i7":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = false;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/OperationObserver.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 class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.cayenne.access</a></div>
<h2 title="Interface OperationObserver" class="title">Interface OperationObserver</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code><a href="OperationHints.html" title="interface in org.apache.cayenne.access">OperationHints</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="util/DefaultOperationObserver.html" title="class in org.apache.cayenne.access.util">DefaultOperationObserver</a></code>, <code><a href="util/DoNothingOperationObserver.html" title="class in org.apache.cayenne.access.util">DoNothingOperationObserver</a></code>, <code><a href="util/IteratedSelectObserver.html" title="class in org.apache.cayenne.access.util">IteratedSelectObserver</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">OperationObserver</span>
extends <a href="OperationHints.html" title="interface in org.apache.cayenne.access">OperationHints</a></pre>
<div class="block">Defines a set of callback methods that allow <a href="QueryEngine.html" title="interface in org.apache.cayenne.access"><code>QueryEngine</code></a> to pass back query
results and notify caller about exceptions.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nextBatchCount(org.apache.cayenne.query.Query,int%5B%5D)">nextBatchCount</a></span>&#8203;(<a href="../query/Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;query,
int[]&nbsp;resultCount)</code></th>
<td class="colLast">
<div class="block">Callback method invoked after a batch update is executed.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nextCount(org.apache.cayenne.query.Query,int)">nextCount</a></span>&#8203;(<a href="../query/Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;query,
int&nbsp;resultCount)</code></th>
<td class="colLast">
<div class="block">Callback method invoked after an updating query is executed.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nextGeneratedRows(org.apache.cayenne.query.Query,org.apache.cayenne.ResultIterator,java.util.List)">nextGeneratedRows</a></span>&#8203;(<a href="../query/Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;query,
<a href="../ResultIterator.html" title="interface in org.apache.cayenne">ResultIterator</a>&lt;?&gt;&nbsp;keys,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="../ObjectId.html" title="interface in org.apache.cayenne">ObjectId</a>&gt;&nbsp;idsToUpdate)</code></th>
<td class="colLast">
<div class="block">Callback method invoked after each batch of generated values is read during an update.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>default void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nextGeneratedRows(org.apache.cayenne.query.Query,org.apache.cayenne.ResultIterator,org.apache.cayenne.ObjectId)">nextGeneratedRows</a></span>&#8203;(<a href="../query/Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;query,
<a href="../ResultIterator.html" title="interface in org.apache.cayenne">ResultIterator</a>&lt;?&gt;&nbsp;keys,
<a href="../ObjectId.html" title="interface in org.apache.cayenne">ObjectId</a>&nbsp;idToUpdate)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">since 4.2, use <a href="#nextGeneratedRows(org.apache.cayenne.query.Query,org.apache.cayenne.ResultIterator,java.util.List)"><code>nextGeneratedRows(Query, ResultIterator, List)</code></a></div>
</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nextGlobalException(java.lang.Exception)">nextGlobalException</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a>&nbsp;ex)</code></th>
<td class="colLast">
<div class="block">Callback method invoked on exceptions that are not tied to a specific query
execution, such as JDBC connection exceptions, etc.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nextQueryException(org.apache.cayenne.query.Query,java.lang.Exception)">nextQueryException</a></span>&#8203;(<a href="../query/Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;query,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a>&nbsp;ex)</code></th>
<td class="colLast">
<div class="block">Callback method invoked on exceptions that happen during an execution of a specific
query.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nextRows(org.apache.cayenne.query.Query,java.util.List)">nextRows</a></span>&#8203;(<a href="../query/Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;query,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;?&gt;&nbsp;dataRows)</code></th>
<td class="colLast">
<div class="block">Callback method invoked for each processed ResultSet.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nextRows(org.apache.cayenne.query.Query,org.apache.cayenne.ResultIterator)">nextRows</a></span>&#8203;(<a href="../query/Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;q,
<a href="../ResultIterator.html" title="interface in org.apache.cayenne">ResultIterator</a>&lt;?&gt;&nbsp;it)</code></th>
<td class="colLast">
<div class="block">Callback method invoked for each opened ResultIterator.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.cayenne.access.OperationHints">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.cayenne.access.<a href="OperationHints.html" title="interface in org.apache.cayenne.access">OperationHints</a></h3>
<code><a href="OperationHints.html#isIteratedResult()">isIteratedResult</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="nextCount(org.apache.cayenne.query.Query,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextCount</h4>
<pre class="methodSignature">void&nbsp;nextCount&#8203;(<a href="../query/Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;query,
int&nbsp;resultCount)</pre>
<div class="block">Callback method invoked after an updating query is executed.</div>
</li>
</ul>
<a id="nextBatchCount(org.apache.cayenne.query.Query,int[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextBatchCount</h4>
<pre class="methodSignature">void&nbsp;nextBatchCount&#8203;(<a href="../query/Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;query,
int[]&nbsp;resultCount)</pre>
<div class="block">Callback method invoked after a batch update is executed.</div>
</li>
</ul>
<a id="nextRows(org.apache.cayenne.query.Query,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextRows</h4>
<pre class="methodSignature">void&nbsp;nextRows&#8203;(<a href="../query/Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;query,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;?&gt;&nbsp;dataRows)</pre>
<div class="block">Callback method invoked for each processed ResultSet.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a id="nextRows(org.apache.cayenne.query.Query,org.apache.cayenne.ResultIterator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextRows</h4>
<pre class="methodSignature">void&nbsp;nextRows&#8203;(<a href="../query/Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;q,
<a href="../ResultIterator.html" title="interface in org.apache.cayenne">ResultIterator</a>&lt;?&gt;&nbsp;it)</pre>
<div class="block">Callback method invoked for each opened ResultIterator. If this observer requested
results to be returned as a ResultIterator, this method is invoked instead of
<a href="#nextRows(org.apache.cayenne.query.Query,java.util.List)"><code>nextRows(Query, List)</code></a>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a id="nextGeneratedRows(org.apache.cayenne.query.Query,org.apache.cayenne.ResultIterator,org.apache.cayenne.ObjectId)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextGeneratedRows</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a>
default&nbsp;void&nbsp;nextGeneratedRows&#8203;(<a href="../query/Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;query,
<a href="../ResultIterator.html" title="interface in org.apache.cayenne">ResultIterator</a>&lt;?&gt;&nbsp;keys,
<a href="../ObjectId.html" title="interface in org.apache.cayenne">ObjectId</a>&nbsp;idToUpdate)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">since 4.2, use <a href="#nextGeneratedRows(org.apache.cayenne.query.Query,org.apache.cayenne.ResultIterator,java.util.List)"><code>nextGeneratedRows(Query, ResultIterator, List)</code></a></div>
</div>
<div class="block">Callback method invoked after each batch of generated values is read during an update.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a id="nextGeneratedRows(org.apache.cayenne.query.Query,org.apache.cayenne.ResultIterator,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextGeneratedRows</h4>
<pre class="methodSignature">void&nbsp;nextGeneratedRows&#8203;(<a href="../query/Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;query,
<a href="../ResultIterator.html" title="interface in org.apache.cayenne">ResultIterator</a>&lt;?&gt;&nbsp;keys,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="../ObjectId.html" title="interface in org.apache.cayenne">ObjectId</a>&gt;&nbsp;idsToUpdate)</pre>
<div class="block">Callback method invoked after each batch of generated values is read during an update.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.2</dd>
</dl>
</li>
</ul>
<a id="nextQueryException(org.apache.cayenne.query.Query,java.lang.Exception)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextQueryException</h4>
<pre class="methodSignature">void&nbsp;nextQueryException&#8203;(<a href="../query/Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;query,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a>&nbsp;ex)</pre>
<div class="block">Callback method invoked on exceptions that happen during an execution of a specific
query.</div>
</li>
</ul>
<a id="nextGlobalException(java.lang.Exception)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>nextGlobalException</h4>
<pre class="methodSignature">void&nbsp;nextGlobalException&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a>&nbsp;ex)</pre>
<div class="block">Callback method invoked on exceptions that are not tied to a specific query
execution, such as JDBC connection exceptions, etc.</div>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/OperationObserver.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 class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2001&#x2013;2022 <a href="https://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</footer>
</body>
</html>