Google Git
Sign in
apache / cayenne-website / 0af753b3ec346c0432aa26fe6065228badfd46ed / . / docs / 3.1 / api / org / apache / cayenne / DataChannelListener.html
blob: 01d04e32c1166c2cb8640419b79b737a9131371f [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 (version 1.7.0_67) on Sat Sep 20 17:22:57 FET 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>DataChannelListener (Cayenne Documentation 3.1 API)</title>
<meta name="date" content="2014-09-20">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DataChannelListener (Cayenne Documentation 3.1 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/DataChannelListener.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/cayenne/DataChannelFilterChain.html" title="interface in org.apache.cayenne"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/cayenne/DataChannelSyncCallbackAction.html" title="class in org.apache.cayenne"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/cayenne/DataChannelListener.html" target="_top">Frames</a></li>
<li><a href="DataChannelListener.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All 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.cayenne</div>
<h2 title="Interface DataChannelListener" class="title">Interface DataChannelListener</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">DataChannelListener</span></pre>
<div class="block">A listener of <a href="../../../org/apache/cayenne/DataChannel.html" title="interface in org.apache.cayenne"><code>DataChannel</code></a> lifecycle events. Changes
related to an event are attached as a GraphDiff. If a listener needs to process these
changes, the easiest way to do that is via GraphChangeHandler "visitor":
<pre>
public void graphChanged(GraphEvent event) {
GraphChangeHandler handler = ..;
event.getDiff().apply(handler);
}
</pre></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd></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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/cayenne/DataChannelListener.html#graphChanged(org.apache.cayenne.graph.GraphEvent)">graphChanged</a></strong>(<a href="../../../org/apache/cayenne/graph/GraphEvent.html" title="class in org.apache.cayenne.graph">GraphEvent</a>&nbsp;event)</code>
<div class="block">Notifies implementing object of the changes that were performed to the object graph
externally, not by one of the channel ObjectContexts.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/cayenne/DataChannelListener.html#graphFlushed(org.apache.cayenne.graph.GraphEvent)">graphFlushed</a></strong>(<a href="../../../org/apache/cayenne/graph/GraphEvent.html" title="class in org.apache.cayenne.graph">GraphEvent</a>&nbsp;event)</code>
<div class="block">Notifies implementing object that one of the channel ObjectContexts flushed its
changes to the channel.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/cayenne/DataChannelListener.html#graphRolledback(org.apache.cayenne.graph.GraphEvent)">graphRolledback</a></strong>(<a href="../../../org/apache/cayenne/graph/GraphEvent.html" title="class in org.apache.cayenne.graph">GraphEvent</a>&nbsp;event)</code>
<div class="block">Notifies implementing object that one of the channel ObjectContexts initiated a
rollback.</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="graphChanged(org.apache.cayenne.graph.GraphEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>graphChanged</h4>
<pre>void&nbsp;graphChanged(<a href="../../../org/apache/cayenne/graph/GraphEvent.html" title="class in org.apache.cayenne.graph">GraphEvent</a>&nbsp;event)</pre>
<div class="block">Notifies implementing object of the changes that were performed to the object graph
externally, not by one of the channel ObjectContexts.</div>
</li>
</ul>
<a name="graphFlushed(org.apache.cayenne.graph.GraphEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>graphFlushed</h4>
<pre>void&nbsp;graphFlushed(<a href="../../../org/apache/cayenne/graph/GraphEvent.html" title="class in org.apache.cayenne.graph">GraphEvent</a>&nbsp;event)</pre>
<div class="block">Notifies implementing object that one of the channel ObjectContexts flushed its
changes to the channel.</div>
</li>
</ul>
<a name="graphRolledback(org.apache.cayenne.graph.GraphEvent)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>graphRolledback</h4>
<pre>void&nbsp;graphRolledback(<a href="../../../org/apache/cayenne/graph/GraphEvent.html" title="class in org.apache.cayenne.graph">GraphEvent</a>&nbsp;event)</pre>
<div class="block">Notifies implementing object that one of the channel ObjectContexts initiated a
rollback.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/DataChannelListener.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/cayenne/DataChannelFilterChain.html" title="interface in org.apache.cayenne"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/cayenne/DataChannelSyncCallbackAction.html" title="class in org.apache.cayenne"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/cayenne/DataChannelListener.html" target="_top">Frames</a></li>
<li><a href="DataChannelListener.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All 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; 2001&#x2013;2014 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</body>
</html>