| <!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.6.0) on Fri Oct 16 14:57:47 EDT 2009 --> |
| <TITLE> |
| PessimisticLockScope (EclipseLink 1.2.0, build 'v20091016-r5565' API Reference) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2009-10-16"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="PessimisticLockScope (EclipseLink 1.2.0, build 'v20091016-r5565' API Reference)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= 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> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| EclipseLink 1.2.0, build 'v20091016-r5565' API Reference</EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../javax/persistence/PessimisticLockException.html" title="class in javax.persistence"><B>PREV CLASS</B></A> |
| <A HREF="../../javax/persistence/PostLoad.html" title="annotation in javax.persistence"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../index.html?javax/persistence/PessimisticLockScope.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="PessimisticLockScope.html" target="_top"><B>NO FRAMES</B></A> |
| <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: NESTED | <A HREF="#enum_constant_summary">ENUM CONSTANTS</A> | FIELD | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#enum_constant_detail">ENUM CONSTANTS</A> | FIELD | <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"> |
| javax.persistence</FONT> |
| <BR> |
| Enum PessimisticLockScope</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Enum<<A HREF="../../javax/persistence/PessimisticLockScope.html" title="enum in javax.persistence">PessimisticLockScope</A>> |
| <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>javax.persistence.PessimisticLockScope</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, java.lang.Comparable<<A HREF="../../javax/persistence/PessimisticLockScope.html" title="enum in javax.persistence">PessimisticLockScope</A>></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public enum <B>PessimisticLockScope</B><DT>extends java.lang.Enum<<A HREF="../../javax/persistence/PessimisticLockScope.html" title="enum in javax.persistence">PessimisticLockScope</A>></DL> |
| </PRE> |
| |
| <P> |
| Defines the values of the <code>javax.persistence.lock.scope</code> |
| property for pessimistic locking. This property may be passed as |
| an argument to the methods of the <A HREF="../../javax/persistence/EntityManager.html" title="interface in javax.persistence"><CODE>EntityManager</CODE></A>, |
| <A HREF="../../javax/persistence/Query.html" title="interface in javax.persistence"><CODE>Query</CODE></A>, and <A HREF="../../javax/persistence/TypedQuery.html" title="interface in javax.persistence"><CODE>TypedQuery</CODE></A> interfaces that |
| allow lock modes to be specified or used with the |
| <A HREF="../../javax/persistence/NamedQuery.html" title="annotation in javax.persistence"><CODE>NamedQuery</CODE></A> annotation. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>Java Persistence 2.0</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- =========== ENUM CONSTANT SUMMARY =========== --> |
| |
| <A NAME="enum_constant_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>Enum Constant Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../javax/persistence/PessimisticLockScope.html#EXTENDED">EXTENDED</A></B></CODE> |
| |
| <BR> |
| In addition to the behavior for |
| <code>PessimisticLockScope.NORMAL</code>, element collections |
| and relationships owned by the entity that are contained in |
| join tables will be locked if the <code>javax.persistence.lock.scope</code> |
| property is specified with a value of |
| <code>PessimisticLockScope.EXTENDED</code>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../javax/persistence/PessimisticLockScope.html#NORMAL">NORMAL</A></B></CODE> |
| |
| <BR> |
| This value defines the default behavior for pessimistic locking.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== 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>static <A HREF="../../javax/persistence/PessimisticLockScope.html" title="enum in javax.persistence">PessimisticLockScope</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../javax/persistence/PessimisticLockScope.html#valueOf(java.lang.String)">valueOf</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Returns the enum constant of this type with the specified name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../javax/persistence/PessimisticLockScope.html" title="enum in javax.persistence">PessimisticLockScope</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../javax/persistence/PessimisticLockScope.html#values()">values</A></B>()</CODE> |
| |
| <BR> |
| Returns an array containing the constants of this enum type, in |
| the order they are declared.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Enum"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.Enum</B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>getClass, notify, notifyAll, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ ENUM CONSTANT DETAIL =========== --> |
| |
| <A NAME="enum_constant_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>Enum Constant Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="NORMAL"><!-- --></A><H3> |
| NORMAL</H3> |
| <PRE> |
| public static final <A HREF="../../javax/persistence/PessimisticLockScope.html" title="enum in javax.persistence">PessimisticLockScope</A> <B>NORMAL</B></PRE> |
| <DL> |
| <DD>This value defines the default behavior for pessimistic locking. |
| |
| <p>The persistence provider must lock the database row(s) that |
| correspond to the non-collection-valued persistent state of |
| that instance. If a joined inheritance strategy is used, or if |
| the entity is otherwise mapped to a secondary table, this |
| entails locking the row(s) for the entity instance in the |
| additional table(s). Entity relationships for which the locked |
| entity contains the foreign key will also be locked, but not |
| the state of the referenced entities (unless those entities are |
| explicitly locked). Element collections and relationships for |
| which the entity does not contain the foreign key (such as |
| relationships that are mapped to join tables or unidirectional |
| one-to-many relationships for which the target entity contains |
| the foreign key) will not be locked by default. |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="EXTENDED"><!-- --></A><H3> |
| EXTENDED</H3> |
| <PRE> |
| public static final <A HREF="../../javax/persistence/PessimisticLockScope.html" title="enum in javax.persistence">PessimisticLockScope</A> <B>EXTENDED</B></PRE> |
| <DL> |
| <DD>In addition to the behavior for |
| <code>PessimisticLockScope.NORMAL</code>, element collections |
| and relationships owned by the entity that are contained in |
| join tables will be locked if the <code>javax.persistence.lock.scope</code> |
| property is specified with a value of |
| <code>PessimisticLockScope.EXTENDED</code>. |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| |
| <!-- ============ 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="values()"><!-- --></A><H3> |
| values</H3> |
| <PRE> |
| public static <A HREF="../../javax/persistence/PessimisticLockScope.html" title="enum in javax.persistence">PessimisticLockScope</A>[] <B>values</B>()</PRE> |
| <DL> |
| <DD>Returns an array containing the constants of this enum type, in |
| the order they are declared. This method may be used to iterate |
| over the constants as follows: |
| <pre> |
| for (PessimisticLockScope c : PessimisticLockScope.values()) |
| System.out.println(c); |
| </pre> |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>an array containing the constants of this enum type, in |
| the order they are declared</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="valueOf(java.lang.String)"><!-- --></A><H3> |
| valueOf</H3> |
| <PRE> |
| public static <A HREF="../../javax/persistence/PessimisticLockScope.html" title="enum in javax.persistence">PessimisticLockScope</A> <B>valueOf</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD>Returns the enum constant of this type with the specified name. |
| The string must match <I>exactly</I> an identifier used to declare an |
| enum constant in this type. (Extraneous whitespace characters are |
| not permitted.) |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the enum constant to be returned. |
| <DT><B>Returns:</B><DD>the enum constant with the specified name |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.IllegalArgumentException</CODE> - if this enum type has no constant |
| with the specified name |
| <DD><CODE>java.lang.NullPointerException</CODE> - if the argument is null</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> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| EclipseLink 1.2.0, build 'v20091016-r5565' API Reference</EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../javax/persistence/PessimisticLockException.html" title="class in javax.persistence"><B>PREV CLASS</B></A> |
| <A HREF="../../javax/persistence/PostLoad.html" title="annotation in javax.persistence"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../index.html?javax/persistence/PessimisticLockScope.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="PessimisticLockScope.html" target="_top"><B>NO FRAMES</B></A> |
| <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: NESTED | <A HREF="#enum_constant_summary">ENUM CONSTANTS</A> | FIELD | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#enum_constant_detail">ENUM CONSTANTS</A> | FIELD | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
