01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * // Copyright (c) 1998, 2007, Oracle. All rights reserved.
05: *
06: *
07: * The contents of this file are subject to the terms of either the GNU
08: * General Public License Version 2 only ("GPL") or the Common Development
09: * and Distribution License("CDDL") (collectively, the "License"). You
10: * may not use this file except in compliance with the License. You can obtain
11: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
12: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
13: * language governing permissions and limitations under the License.
14: *
15: * When distributing the software, include this License Header Notice in each
16: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
17: * Sun designates this particular file as subject to the "Classpath" exception
18: * as provided by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the License
20: * Header, with the fields enclosed by brackets [] replaced by your own
21: * identifying information: "Portions Copyrighted [year]
22: * [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * If you wish your version of this file to be governed by only the CDDL or
27: * only the GPL Version 2, indicate your decision by adding "[Contributor]
28: * elects to include this software in this distribution under the [CDDL or GPL
29: * Version 2] license." If you don't indicate a single choice of license, a
30: * recipient has the option to distribute your version of this file under
31: * either the CDDL, the GPL Version 2 or to extend the choice of license to
32: * its licensees as provided above. However, if you add GPL Version 2 code
33: * and therefore, elected the GPL Version 2 license, then the option applies
34: * only if the new code is made subject to such option by the copyright
35: * holder.
36: */
37: package oracle.toplink.essentials.ejb.cmp3;
38:
39: import oracle.toplink.essentials.sessions.*;
40: import oracle.toplink.essentials.expressions.Expression;
41: import oracle.toplink.essentials.threetier.ServerSession;
42:
43: /**
44: * <p>
45: * <b>Purpose</b>: Defines the Interface for TopLink extensions to the EntityManager
46: * <p>
47: * @see javax.persistence.EntityManager
48: */
49: /*
50: * @author Gordon Yorke
51: */
52:
53: public interface EntityManager extends javax.persistence.EntityManager {
54:
55: /**
56: * This method returns the current session to the requestor. The current session
57: * will be a the active UnitOfWork within a transaction and will be a 'scrap'
58: * UnitOfWork outside of a transaction. The caller is conserned about the results
59: * then the getSession() or getUnitOfWork() API should be called.
60: */
61: public Session getActiveSession();
62:
63: /**
64: * Return the underlying server session
65: */
66: public ServerSession getServerSession();
67:
68: /**
69: * This method will return the transactional UnitOfWork during the transaction and null
70: * outside of the transaction.
71: */
72: public UnitOfWork getUnitOfWork();
73:
74: /**
75: * This method will return a Session outside of a transaction and null within a transaction.
76: */
77: public Session getSession();
78:
79: /**
80: * This method is used to create a query using a Toplink Expression and the return type.
81: */
82: public javax.persistence.Query createQuery(Expression expression,
83: Class resultType);
84:
85: }
|