blob: db0068a4d877867172bdbd41ef1c0cbd41287aa1 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_06) on Wed Jul 19 14:42:41 EDT 2006 -->
<TITLE>
TransactionDelegate (Cayenne API Documentation - v.1.2)
</TITLE>
<META NAME="keywords" CONTENT="org.objectstyle.cayenne.access.TransactionDelegate interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../objectstyle-javadoc.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="TransactionDelegate (Cayenne API Documentation - v.1.2)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/objectstyle/cayenne/access/Transaction.html" title="class in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/objectstyle/cayenne/access/TransactionDelegate.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="TransactionDelegate.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.objectstyle.cayenne.access</FONT>
<BR>
Interface TransactionDelegate</H2>
<HR>
<DL>
<DT><PRE>public interface <B>TransactionDelegate</B></DL>
</PRE>
<P>
Defines callback methods for tracking and customizing Transactions execution.
<P>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>1.1</DD>
<DT><B>Author:</B></DT>
<DD>Andrus Adamchik</DD>
</DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/TransactionDelegate.html#didCommit(org.objectstyle.cayenne.access.Transaction)">didCommit</A></B>(<A HREF="../../../../org/objectstyle/cayenne/access/Transaction.html" title="class in org.objectstyle.cayenne.access">Transaction</A>&nbsp;transaction)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called after a Transaction commit.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/TransactionDelegate.html#didRollback(org.objectstyle.cayenne.access.Transaction)">didRollback</A></B>(<A HREF="../../../../org/objectstyle/cayenne/access/Transaction.html" title="class in org.objectstyle.cayenne.access">Transaction</A>&nbsp;transaction)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called after a Transaction is rolledback.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/TransactionDelegate.html#willAddConnection(org.objectstyle.cayenne.access.Transaction, java.sql.Connection)">willAddConnection</A></B>(<A HREF="../../../../org/objectstyle/cayenne/access/Transaction.html" title="class in org.objectstyle.cayenne.access">Transaction</A>&nbsp;transaction,
java.sql.Connection&nbsp;connection)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called within a context of a Transaction when a new JDBC onnection is added to the
the transaction.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/TransactionDelegate.html#willCommit(org.objectstyle.cayenne.access.Transaction)">willCommit</A></B>(<A HREF="../../../../org/objectstyle/cayenne/access/Transaction.html" title="class in org.objectstyle.cayenne.access">Transaction</A>&nbsp;transaction)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called within a context of a Transaction before the transaction is committed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/TransactionDelegate.html#willMarkAsRollbackOnly(org.objectstyle.cayenne.access.Transaction)">willMarkAsRollbackOnly</A></B>(<A HREF="../../../../org/objectstyle/cayenne/access/Transaction.html" title="class in org.objectstyle.cayenne.access">Transaction</A>&nbsp;transaction)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called within a context of a Transaction before transaction is marked as "rollback
only", meaning that further commit is not possible.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/TransactionDelegate.html#willRollback(org.objectstyle.cayenne.access.Transaction)">willRollback</A></B>(<A HREF="../../../../org/objectstyle/cayenne/access/Transaction.html" title="class in org.objectstyle.cayenne.access">Transaction</A>&nbsp;transaction)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called within a context of a Transaction before the transaction is rolledback.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="willCommit(org.objectstyle.cayenne.access.Transaction)"><!-- --></A><H3>
willCommit</H3>
<PRE>
boolean <B>willCommit</B>(<A HREF="../../../../org/objectstyle/cayenne/access/Transaction.html" title="class in org.objectstyle.cayenne.access">Transaction</A>&nbsp;transaction)</PRE>
<DL>
<DD>Called within a context of a Transaction before the transaction is committed.
Delegate can do its own processing, and optionally suppress further commit
processing by Cayenne by returning <code>false</code>.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="willMarkAsRollbackOnly(org.objectstyle.cayenne.access.Transaction)"><!-- --></A><H3>
willMarkAsRollbackOnly</H3>
<PRE>
boolean <B>willMarkAsRollbackOnly</B>(<A HREF="../../../../org/objectstyle/cayenne/access/Transaction.html" title="class in org.objectstyle.cayenne.access">Transaction</A>&nbsp;transaction)</PRE>
<DL>
<DD>Called within a context of a Transaction before transaction is marked as "rollback
only", meaning that further commit is not possible. Delegate can do its own
processing, and optionally suppress setting transaction status by returning
<code>false</code>.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="willRollback(org.objectstyle.cayenne.access.Transaction)"><!-- --></A><H3>
willRollback</H3>
<PRE>
boolean <B>willRollback</B>(<A HREF="../../../../org/objectstyle/cayenne/access/Transaction.html" title="class in org.objectstyle.cayenne.access">Transaction</A>&nbsp;transaction)</PRE>
<DL>
<DD>Called within a context of a Transaction before the transaction is rolledback.
Delegate can do its own processing, and optionally suppress further rollback
processing by Cayenne by returning <code>false</code>.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="didCommit(org.objectstyle.cayenne.access.Transaction)"><!-- --></A><H3>
didCommit</H3>
<PRE>
void <B>didCommit</B>(<A HREF="../../../../org/objectstyle/cayenne/access/Transaction.html" title="class in org.objectstyle.cayenne.access">Transaction</A>&nbsp;transaction)</PRE>
<DL>
<DD>Called after a Transaction commit.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="didRollback(org.objectstyle.cayenne.access.Transaction)"><!-- --></A><H3>
didRollback</H3>
<PRE>
void <B>didRollback</B>(<A HREF="../../../../org/objectstyle/cayenne/access/Transaction.html" title="class in org.objectstyle.cayenne.access">Transaction</A>&nbsp;transaction)</PRE>
<DL>
<DD>Called after a Transaction is rolledback.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="willAddConnection(org.objectstyle.cayenne.access.Transaction, java.sql.Connection)"><!-- --></A><H3>
willAddConnection</H3>
<PRE>
boolean <B>willAddConnection</B>(<A HREF="../../../../org/objectstyle/cayenne/access/Transaction.html" title="class in org.objectstyle.cayenne.access">Transaction</A>&nbsp;transaction,
java.sql.Connection&nbsp;connection)</PRE>
<DL>
<DD>Called within a context of a Transaction when a new JDBC onnection is added to the
the transaction. Delegate can do its own processing, and optionally suppress
connection registration with the transaction by returning <code>false</code>.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/objectstyle/cayenne/access/Transaction.html" title="class in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/objectstyle/cayenne/access/TransactionDelegate.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="TransactionDelegate.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<!--@SFLOGO@--> &nbsp; <i>Copyright &#169; 2001-2006 <a href=
"http://objectstyle.org" target="_top">ObjectStyle.org</a> All Rights Reserved.</i>
</BODY>
</HTML>