blob: d5defcc56a795303ced924dfde3f80a137f86193 [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:45:43 EDT 2006 -->
<TITLE>
ObjectContext (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.cayenne.ObjectContext interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../apache-javadoc.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="ObjectContext (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT)";
}
</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/apache/cayenne/FaultFailureException.html" title="class in org.apache.cayenne"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../org/apache/cayenne/ObjectId.html" title="class in org.apache.cayenne"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?org/apache/cayenne/ObjectContext.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ObjectContext.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.apache.cayenne</FONT>
<BR>
Interface ObjectContext</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD>java.io.Serializable</DD>
</DL>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../org/apache/cayenne/CayenneContext.html" title="class in org.apache.cayenne">CayenneContext</A>, <A HREF="../../../org/apache/cayenne/access/DataContext.html" title="class in org.apache.cayenne.access">DataContext</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>ObjectContext</B><DT>extends java.io.Serializable</DL>
</PRE>
<P>
A Cayenne object facade to a persistent store. Instances of ObjectContext are used in
the application code to access Cayenne persistence features.
<P>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>1.2</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/apache/cayenne/ObjectContext.html#commitChanges()">commitChanges</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Flushes all changes to objects in this context to the parent DataChannel, cascading
flush operation all the way through the stack, ultimately saving data in the
database.</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/apache/cayenne/ObjectContext.html#commitChangesToParent()">commitChangesToParent</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Flushes all changes to objects in this context to the parent DataChannel.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.util.Collection</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/cayenne/ObjectContext.html#deletedObjects()">deletedObjects</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a collection of objects that are registered with this ObjectContext and
have a state PersistenceState.DELETED</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/apache/cayenne/ObjectContext.html#deleteObject(org.apache.cayenne.Persistent)">deleteObject</A></B>(<A HREF="../../../org/apache/cayenne/Persistent.html" title="interface in org.apache.cayenne">Persistent</A>&nbsp;object)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Schedules a persistent object for deletion on next commit.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../org/apache/cayenne/DataChannel.html" title="interface in org.apache.cayenne">DataChannel</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/cayenne/ObjectContext.html#getChannel()">getChannel</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an DataChannel used by this context.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/cayenne/ObjectContext.html#getEntityResolver()">getEntityResolver</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns EntityResolver that stores all mapping information accessible by this
ObjectContext.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../org/apache/cayenne/graph/GraphManager.html" title="interface in org.apache.cayenne.graph">GraphManager</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/cayenne/ObjectContext.html#getGraphManager()">getGraphManager</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns GraphManager that manages object graph associated with this context.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../org/apache/cayenne/Persistent.html" title="interface in org.apache.cayenne">Persistent</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/cayenne/ObjectContext.html#localObject(org.apache.cayenne.ObjectId, org.apache.cayenne.Persistent)">localObject</A></B>(<A HREF="../../../org/apache/cayenne/ObjectId.html" title="class in org.apache.cayenne">ObjectId</A>&nbsp;id,
<A HREF="../../../org/apache/cayenne/Persistent.html" title="interface in org.apache.cayenne">Persistent</A>&nbsp;prototype)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an object local to this ObjectContext and matching the ObjectId.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.util.Collection</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/cayenne/ObjectContext.html#modifiedObjects()">modifiedObjects</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a collection of objects that are registered with this ObjectContext and
have a state PersistenceState.MODIFIED</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../org/apache/cayenne/Persistent.html" title="interface in org.apache.cayenne">Persistent</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/cayenne/ObjectContext.html#newObject(java.lang.Class)">newObject</A></B>(java.lang.Class&nbsp;persistentClass)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new persistent object scheduled to be inserted to the database on next
commit.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.util.Collection</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/cayenne/ObjectContext.html#newObjects()">newObjects</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a collection of objects that are registered with this ObjectContext and
have a state PersistenceState.NEW</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../org/apache/cayenne/QueryResponse.html" title="interface in org.apache.cayenne">QueryResponse</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/cayenne/ObjectContext.html#performGenericQuery(org.apache.cayenne.query.Query)">performGenericQuery</A></B>(<A HREF="../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A>&nbsp;query)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Executes any kind of query providing the result in a form of QueryResponse.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.util.List</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/cayenne/ObjectContext.html#performQuery(org.apache.cayenne.query.Query)">performQuery</A></B>(<A HREF="../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A>&nbsp;query)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Executes a selecting query, returning a list of persistent objects or data rows.</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/apache/cayenne/ObjectContext.html#prepareForAccess(org.apache.cayenne.Persistent, java.lang.String)">prepareForAccess</A></B>(<A HREF="../../../org/apache/cayenne/Persistent.html" title="interface in org.apache.cayenne">Persistent</A>&nbsp;object,
java.lang.String&nbsp;property)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A callback method that child Persistent objects are expected to call from inside
the getter before returning a value of a persistent property.</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/apache/cayenne/ObjectContext.html#propertyChanged(org.apache.cayenne.Persistent, java.lang.String, java.lang.Object, java.lang.Object)">propertyChanged</A></B>(<A HREF="../../../org/apache/cayenne/Persistent.html" title="interface in org.apache.cayenne">Persistent</A>&nbsp;object,
java.lang.String&nbsp;property,
java.lang.Object&nbsp;oldValue,
java.lang.Object&nbsp;newValue)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A callback method that child Persistent objects are expected to call from inside
the setter after modifying a value of a persistent property.</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/apache/cayenne/ObjectContext.html#rollbackChanges()">rollbackChanges</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Resets all uncommitted changes made to the objects in this ObjectContext, cascading
rollback operation all the way through the stack.</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/apache/cayenne/ObjectContext.html#rollbackChangesLocally()">rollbackChangesLocally</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Resets all uncommitted changes made to the objects in this ObjectContext.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.util.Collection</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/cayenne/ObjectContext.html#uncommittedObjects()">uncommittedObjects</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a collection of MODIFIED, DELETED or NEW objects.</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="getEntityResolver()"><!-- --></A><H3>
getEntityResolver</H3>
<PRE>
<A HREF="../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</A> <B>getEntityResolver</B>()</PRE>
<DL>
<DD>Returns EntityResolver that stores all mapping information accessible by this
ObjectContext.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="newObjects()"><!-- --></A><H3>
newObjects</H3>
<PRE>
java.util.Collection <B>newObjects</B>()</PRE>
<DL>
<DD>Returns a collection of objects that are registered with this ObjectContext and
have a state PersistenceState.NEW
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="deletedObjects()"><!-- --></A><H3>
deletedObjects</H3>
<PRE>
java.util.Collection <B>deletedObjects</B>()</PRE>
<DL>
<DD>Returns a collection of objects that are registered with this ObjectContext and
have a state PersistenceState.DELETED
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="modifiedObjects()"><!-- --></A><H3>
modifiedObjects</H3>
<PRE>
java.util.Collection <B>modifiedObjects</B>()</PRE>
<DL>
<DD>Returns a collection of objects that are registered with this ObjectContext and
have a state PersistenceState.MODIFIED
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="uncommittedObjects()"><!-- --></A><H3>
uncommittedObjects</H3>
<PRE>
java.util.Collection <B>uncommittedObjects</B>()</PRE>
<DL>
<DD>Returns a collection of MODIFIED, DELETED or NEW objects.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="localObject(org.apache.cayenne.ObjectId, org.apache.cayenne.Persistent)"><!-- --></A><H3>
localObject</H3>
<PRE>
<A HREF="../../../org/apache/cayenne/Persistent.html" title="interface in org.apache.cayenne">Persistent</A> <B>localObject</B>(<A HREF="../../../org/apache/cayenne/ObjectId.html" title="class in org.apache.cayenne">ObjectId</A>&nbsp;id,
<A HREF="../../../org/apache/cayenne/Persistent.html" title="interface in org.apache.cayenne">Persistent</A>&nbsp;prototype)</PRE>
<DL>
<DD>Returns an object local to this ObjectContext and matching the ObjectId. If
<code>prototype</code> is not null, local object is refreshed with the prototype
values.
<p>
This method can do both "mapping" (i.e. finding an object with the same id in this
context) and "synchronization" (i.e. updating the state of the found object with
the state of the prototype object).
</p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="newObject(java.lang.Class)"><!-- --></A><H3>
newObject</H3>
<PRE>
<A HREF="../../../org/apache/cayenne/Persistent.html" title="interface in org.apache.cayenne">Persistent</A> <B>newObject</B>(java.lang.Class&nbsp;persistentClass)</PRE>
<DL>
<DD>Creates a new persistent object scheduled to be inserted to the database on next
commit.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="deleteObject(org.apache.cayenne.Persistent)"><!-- --></A><H3>
deleteObject</H3>
<PRE>
void <B>deleteObject</B>(<A HREF="../../../org/apache/cayenne/Persistent.html" title="interface in org.apache.cayenne">Persistent</A>&nbsp;object)
throws <A HREF="../../../org/apache/cayenne/DeleteDenyException.html" title="class in org.apache.cayenne">DeleteDenyException</A></PRE>
<DL>
<DD>Schedules a persistent object for deletion on next commit.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/apache/cayenne/DeleteDenyException.html" title="class in org.apache.cayenne">DeleteDenyException</A></CODE> - if a
<A HREF="../../../org/apache/cayenne/map/DeleteRule.html#DENY"><CODE>DeleteRule.DENY</CODE></A> delete rule is
applicable for object deletion.</DL>
</DD>
</DL>
<HR>
<A NAME="prepareForAccess(org.apache.cayenne.Persistent, java.lang.String)"><!-- --></A><H3>
prepareForAccess</H3>
<PRE>
void <B>prepareForAccess</B>(<A HREF="../../../org/apache/cayenne/Persistent.html" title="interface in org.apache.cayenne">Persistent</A>&nbsp;object,
java.lang.String&nbsp;property)</PRE>
<DL>
<DD>A callback method that child Persistent objects are expected to call from inside
the getter before returning a value of a persistent property. Such callback allows
ObjectContext to "inflate" unresolved objects on demand.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="propertyChanged(org.apache.cayenne.Persistent, java.lang.String, java.lang.Object, java.lang.Object)"><!-- --></A><H3>
propertyChanged</H3>
<PRE>
void <B>propertyChanged</B>(<A HREF="../../../org/apache/cayenne/Persistent.html" title="interface in org.apache.cayenne">Persistent</A>&nbsp;object,
java.lang.String&nbsp;property,
java.lang.Object&nbsp;oldValue,
java.lang.Object&nbsp;newValue)</PRE>
<DL>
<DD>A callback method that child Persistent objects are expected to call from inside
the setter after modifying a value of a persistent property.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="commitChanges()"><!-- --></A><H3>
commitChanges</H3>
<PRE>
void <B>commitChanges</B>()</PRE>
<DL>
<DD>Flushes all changes to objects in this context to the parent DataChannel, cascading
flush operation all the way through the stack, ultimately saving data in the
database.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="commitChangesToParent()"><!-- --></A><H3>
commitChangesToParent</H3>
<PRE>
void <B>commitChangesToParent</B>()</PRE>
<DL>
<DD>Flushes all changes to objects in this context to the parent DataChannel. Same as
<A HREF="../../../org/apache/cayenne/ObjectContext.html#commitChanges()"><CODE>commitChanges()</CODE></A>, but no cascading flush occurs.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="rollbackChanges()"><!-- --></A><H3>
rollbackChanges</H3>
<PRE>
void <B>rollbackChanges</B>()</PRE>
<DL>
<DD>Resets all uncommitted changes made to the objects in this ObjectContext, cascading
rollback operation all the way through the stack.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="rollbackChangesLocally()"><!-- --></A><H3>
rollbackChangesLocally</H3>
<PRE>
void <B>rollbackChangesLocally</B>()</PRE>
<DL>
<DD>Resets all uncommitted changes made to the objects in this ObjectContext. Same as
<A HREF="../../../org/apache/cayenne/ObjectContext.html#rollbackChanges()"><CODE>rollbackChanges()()</CODE></A>, but rollback is local to this context and no
cascading changes undoing occurs.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="performQuery(org.apache.cayenne.query.Query)"><!-- --></A><H3>
performQuery</H3>
<PRE>
java.util.List <B>performQuery</B>(<A HREF="../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A>&nbsp;query)</PRE>
<DL>
<DD>Executes a selecting query, returning a list of persistent objects or data rows.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="performGenericQuery(org.apache.cayenne.query.Query)"><!-- --></A><H3>
performGenericQuery</H3>
<PRE>
<A HREF="../../../org/apache/cayenne/QueryResponse.html" title="interface in org.apache.cayenne">QueryResponse</A> <B>performGenericQuery</B>(<A HREF="../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A>&nbsp;query)</PRE>
<DL>
<DD>Executes any kind of query providing the result in a form of QueryResponse.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getGraphManager()"><!-- --></A><H3>
getGraphManager</H3>
<PRE>
<A HREF="../../../org/apache/cayenne/graph/GraphManager.html" title="interface in org.apache.cayenne.graph">GraphManager</A> <B>getGraphManager</B>()</PRE>
<DL>
<DD>Returns GraphManager that manages object graph associated with this context.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getChannel()"><!-- --></A><H3>
getChannel</H3>
<PRE>
<A HREF="../../../org/apache/cayenne/DataChannel.html" title="interface in org.apache.cayenne">DataChannel</A> <B>getChannel</B>()</PRE>
<DL>
<DD>Returns an DataChannel used by this context.
<P>
<DD><DL>
</DL>
</DD>
<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/apache/cayenne/FaultFailureException.html" title="class in org.apache.cayenne"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../org/apache/cayenne/ObjectId.html" title="class in org.apache.cayenne"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?org/apache/cayenne/ObjectContext.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ObjectContext.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>
<i>Copyright &#169; 2001-2006 <a href=
"http://apache.org" target="_top">Apache.org</a> All Rights Reserved.</i>
</BODY>
</HTML>