1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.5.0) on Thu May 15 17:17:33 EDT 2008 --> 6<TITLE> 7DeleteAction (Oracle - Berkeley DB Java API) 8</TITLE> 9 10<META NAME="keywords" CONTENT="com.sleepycat.persist.model.DeleteAction class"> 11 12<LINK REL ="stylesheet" TYPE="text/css" HREF="/style.css" TITLE="Style"> 13 14<SCRIPT type="text/javascript"> 15function windowTitle() 16{ 17 parent.document.title="DeleteAction (Oracle - Berkeley DB Java API)"; 18} 19</SCRIPT> 20<NOSCRIPT> 21</NOSCRIPT> 22 23</HEAD> 24 25<BODY BGCOLOR="white" onload="windowTitle();"> 26 27 28<!-- ========= START OF TOP NAVBAR ======= --> 29<A NAME="navbar_top"><!-- --></A> 30<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 31<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 32<TR> 33<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 34<A NAME="navbar_top_firstrow"><!-- --></A> 35<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 36 <TR ALIGN="center" VALIGN="top"> 37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 39 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DeleteAction.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 45 </TR> 46</TABLE> 47</TD> 48<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 49<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM> 50</TD> 51</TR> 52 53<TR> 54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 55 <A HREF="/com/sleepycat/persist/model/ClassMetadata.html" title="class in com.sleepycat.persist.model"><B>PREV CLASS</B></A> 56 <A HREF="/com/sleepycat/persist/model/Entity.html" title="annotation in com.sleepycat.persist.model"><B>NEXT CLASS</B></A></FONT></TD> 57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 58 <A HREF="/index.html?com/sleepycat/persist/model/DeleteAction.html" target="_top"><B>FRAMES</B></A> 59 <A HREF="DeleteAction.html" target="_top"><B>NO FRAMES</B></A> 60 <SCRIPT type="text/javascript"> 61 <!-- 62 if(window==top) { 63 document.writeln('<A HREF="/allclasses-noframe.html"><B>All Classes</B></A>'); 64 } 65 //--> 66</SCRIPT> 67<NOSCRIPT> 68 <A HREF="/allclasses-noframe.html"><B>All Classes</B></A> 69</NOSCRIPT> 70 71 72</FONT></TD> 73</TR> 74<TR> 75<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 76 SUMMARY: NESTED | <A HREF="#enum_constant_summary">ENUM CONSTANTS</A> | FIELD | <A HREF="#method_summary">METHOD</A></FONT></TD> 77<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 78DETAIL: <A HREF="#enum_constant_detail">ENUM CONSTANTS</A> | FIELD | <A HREF="#method_detail">METHOD</A></FONT></TD> 79</TR> 80</TABLE> 81<A NAME="skip-navbar_top"></A> 82<!-- ========= END OF TOP NAVBAR ========= --> 83 84<HR> 85<!-- ======== START OF CLASS DATA ======== --> 86<H2> 87<FONT SIZE="-1"> 88com.sleepycat.persist.model</FONT> 89<BR> 90Enum DeleteAction</H2> 91<PRE> 92<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> 93 <IMG SRC="/resources/inherit.gif" ALT="extended by "><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Enum.html" title="class or interface in java.lang">java.lang.Enum</A><<A HREF="/com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model">DeleteAction</A>> 94 <IMG SRC="/resources/inherit.gif" ALT="extended by "><B>com.sleepycat.persist.model.DeleteAction</B> 95</PRE> 96<DL> 97<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/Serializable.html" title="class or interface in java.io">Serializable</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Comparable.html" title="class or interface in java.lang">Comparable</A><<A HREF="/com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model">DeleteAction</A>></DD> 98</DL> 99<HR> 100<DL> 101<DT><PRE>public enum <B>DeleteAction</B><DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Enum.html" title="class or interface in java.lang">Enum</A><<A HREF="/com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model">DeleteAction</A>></DL> 102</PRE> 103 104<P> 105Specifies the action to take when a related entity is deleted having a 106 primary key value that exists as a secondary key value for this entity. 107 This can be specified using a <A HREF="/com/sleepycat/persist/model/SecondaryKey.html#onRelatedEntityDelete()"><CODE>SecondaryKey.onRelatedEntityDelete()</CODE></A> 108 annotation. 109<P> 110 111<P> 112<HR> 113 114<P> 115<!-- =========== ENUM CONSTANT SUMMARY =========== --> 116 117<A NAME="enum_constant_summary"><!-- --></A> 118<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 119<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 120<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 121<B>Enum Constant Summary</B></FONT></TH> 122</TR> 123<TR BGCOLOR="white" CLASS="TableRowColor"> 124<TD><CODE><B><A HREF="/com/sleepycat/persist/model/DeleteAction.html#ABORT">ABORT</A></B></CODE> 125 126<BR> 127 The default action, <code>ABORT</code>, means that a <A HREF="/com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is thrown in order to abort the current transaction.</TD> 128</TR> 129<TR BGCOLOR="white" CLASS="TableRowColor"> 130<TD><CODE><B><A HREF="/com/sleepycat/persist/model/DeleteAction.html#CASCADE">CASCADE</A></B></CODE> 131 132<BR> 133 If <code>CASCADE</code> is specified, then this entity will be deleted also, 134 which could in turn trigger further deletions, causing a cascading 135 effect.</TD> 136</TR> 137<TR BGCOLOR="white" CLASS="TableRowColor"> 138<TD><CODE><B><A HREF="/com/sleepycat/persist/model/DeleteAction.html#NULLIFY">NULLIFY</A></B></CODE> 139 140<BR> 141 If <code>NULLIFY</code> is specified, then the secondary key in this entity 142 is set to null and this entity is updated.</TD> 143</TR> 144</TABLE> 145 146<!-- ========== METHOD SUMMARY =========== --> 147 148<A NAME="method_summary"><!-- --></A> 149<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 150<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 151<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 152<B>Method Summary</B></FONT></TH> 153</TR> 154<TR BGCOLOR="white" CLASS="TableRowColor"> 155<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 156<CODE>static <A HREF="/com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model">DeleteAction</A></CODE></FONT></TD> 157<TD><CODE><B><A HREF="/com/sleepycat/persist/model/DeleteAction.html#valueOf(java.lang.String)">valueOf</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</CODE> 158 159<BR> 160 Returns the enum constant of this type with the specified name.</TD> 161</TR> 162<TR BGCOLOR="white" CLASS="TableRowColor"> 163<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 164<CODE>static <A HREF="/com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model">DeleteAction</A>[]</CODE></FONT></TD> 165<TD><CODE><B><A HREF="/com/sleepycat/persist/model/DeleteAction.html#values()">values</A></B>()</CODE> 166 167<BR> 168 Returns an array containing the constants of this enum type, in 169the order they're declared.</TD> 170</TR> 171</TABLE> 172 <A NAME="methods_inherited_from_class_java.lang.Enum"><!-- --></A> 173<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 174<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 175<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Enum.html" title="class or interface in java.lang">Enum</A></B></TH> 176</TR> 177<TR BGCOLOR="white" CLASS="TableRowColor"> 178<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Enum.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang">compareTo</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang">getDeclaringClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Enum.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Enum.html#name()" title="class or interface in java.lang">name</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Enum.html#ordinal()" title="class or interface in java.lang">ordinal</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Enum.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Enum.html#valueOf(java.lang.Class, java.lang.String)" title="class or interface in java.lang">valueOf</A></CODE></TD> 179</TR> 180</TABLE> 181 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 182<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 183<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 184<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH> 185</TR> 186<TR BGCOLOR="white" CLASS="TableRowColor"> 187<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> 188</TR> 189</TABLE> 190 191<P> 192 193<!-- ============ ENUM CONSTANT DETAIL =========== --> 194 195<A NAME="enum_constant_detail"><!-- --></A> 196<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 197<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 198<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 199<B>Enum Constant Detail</B></FONT></TH> 200</TR> 201</TABLE> 202 203<A NAME="ABORT"><!-- --></A><H3> 204ABORT</H3> 205<PRE> 206public static final <A HREF="/com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model">DeleteAction</A> <B>ABORT</B></PRE> 207<DL> 208<DD>The default action, <code>ABORT</code>, means that a <A HREF="/com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is thrown in order to abort the current transaction. 209<P> 210<DL> 211</DL> 212</DL> 213<HR> 214 215<A NAME="CASCADE"><!-- --></A><H3> 216CASCADE</H3> 217<PRE> 218public static final <A HREF="/com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model">DeleteAction</A> <B>CASCADE</B></PRE> 219<DL> 220<DD>If <code>CASCADE</code> is specified, then this entity will be deleted also, 221 which could in turn trigger further deletions, causing a cascading 222 effect. 223<P> 224<DL> 225</DL> 226</DL> 227<HR> 228 229<A NAME="NULLIFY"><!-- --></A><H3> 230NULLIFY</H3> 231<PRE> 232public static final <A HREF="/com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model">DeleteAction</A> <B>NULLIFY</B></PRE> 233<DL> 234<DD>If <code>NULLIFY</code> is specified, then the secondary key in this entity 235 is set to null and this entity is updated. For a secondary key field 236 that has an array or collection type, the array or collection element 237 will be removed by this action. The secondary key field must have a 238 reference (not a primitive) type in order to specify this action. 239<P> 240<DL> 241</DL> 242</DL> 243 244<!-- ============ METHOD DETAIL ========== --> 245 246<A NAME="method_detail"><!-- --></A> 247<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 248<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 249<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 250<B>Method Detail</B></FONT></TH> 251</TR> 252</TABLE> 253 254<A NAME="values()"><!-- --></A><H3> 255values</H3> 256<PRE> 257public static final <A HREF="/com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model">DeleteAction</A>[] <B>values</B>()</PRE> 258<DL> 259<DD>Returns an array containing the constants of this enum type, in 260the order they're declared. This method may be used to iterate 261over the constants as follows: 262<pre> 263for(DeleteAction c : DeleteAction.values()) 264 System.out.println(c); 265</pre> 266<P> 267<DD><DL> 268 269<DT><B>Returns:</B><DD>an array containing the constants of this enum type, in 270the order they're declared</DL> 271</DD> 272</DL> 273<HR> 274 275<A NAME="valueOf(java.lang.String)"><!-- --></A><H3> 276valueOf</H3> 277<PRE> 278public static <A HREF="/com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model">DeleteAction</A> <B>valueOf</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</PRE> 279<DL> 280<DD>Returns the enum constant of this type with the specified name. 281The string must match <I>exactly</I> an identifier used to declare an 282enum constant in this type. (Extraneous whitespace characters are 283not permitted.) 284<P> 285<DD><DL> 286<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the enum constant to be returned. 287<DT><B>Returns:</B><DD>the enum constant with the specified name 288<DT><B>Throws:</B> 289<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if this enum type has no constant 290with the specified name</DL> 291</DD> 292</DL> 293<!-- ========= END OF CLASS DATA ========= --> 294<HR> 295 296 297<!-- ======= START OF BOTTOM NAVBAR ====== --> 298<A NAME="navbar_bottom"><!-- --></A> 299<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 300<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 301<TR> 302<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 303<A NAME="navbar_bottom_firstrow"><!-- --></A> 304<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 305 <TR ALIGN="center" VALIGN="top"> 306 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 307 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 308 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 309 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DeleteAction.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 310 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 311 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 312 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 313 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 314 </TR> 315</TABLE> 316</TD> 317<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 318<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM> 319</TD> 320</TR> 321 322<TR> 323<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 324 <A HREF="/com/sleepycat/persist/model/ClassMetadata.html" title="class in com.sleepycat.persist.model"><B>PREV CLASS</B></A> 325 <A HREF="/com/sleepycat/persist/model/Entity.html" title="annotation in com.sleepycat.persist.model"><B>NEXT CLASS</B></A></FONT></TD> 326<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 327 <A HREF="/index.html?com/sleepycat/persist/model/DeleteAction.html" target="_top"><B>FRAMES</B></A> 328 <A HREF="DeleteAction.html" target="_top"><B>NO FRAMES</B></A> 329 <SCRIPT type="text/javascript"> 330 <!-- 331 if(window==top) { 332 document.writeln('<A HREF="/allclasses-noframe.html"><B>All Classes</B></A>'); 333 } 334 //--> 335</SCRIPT> 336<NOSCRIPT> 337 <A HREF="/allclasses-noframe.html"><B>All Classes</B></A> 338</NOSCRIPT> 339 340 341</FONT></TD> 342</TR> 343<TR> 344<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 345 SUMMARY: NESTED | <A HREF="#enum_constant_summary">ENUM CONSTANTS</A> | FIELD | <A HREF="#method_summary">METHOD</A></FONT></TD> 346<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 347DETAIL: <A HREF="#enum_constant_detail">ENUM CONSTANTS</A> | FIELD | <A HREF="#method_detail">METHOD</A></FONT></TD> 348</TR> 349</TABLE> 350<A NAME="skip-navbar_bottom"></A> 351<!-- ======== END OF BOTTOM NAVBAR ======= --> 352 353<HR> 354<font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> 355</BODY> 356</HTML> 357
