oracle.toplink.essentials.ejb.cmp3.EntityManager Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* // Copyright (c) 1998, 2007, Oracle. All rights reserved.
*
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package oracle.toplink.essentials.ejb.cmp3;
import oracle.toplink.essentials.sessions.*;
import oracle.toplink.essentials.expressions.Expression;
import oracle.toplink.essentials.threetier.ServerSession;
/**
*
* Purpose: Defines the Interface for TopLink extensions to the EntityManager
*
* @see javax.persistence.EntityManager
*/
/*
* @author Gordon Yorke
*/
public interface EntityManager extends javax.persistence.EntityManager {
/**
* This method returns the current session to the requestor. The current session
* will be a the active UnitOfWork within a transaction and will be a 'scrap'
* UnitOfWork outside of a transaction. The caller is conserned about the results
* then the getSession() or getUnitOfWork() API should be called.
*/
public Session getActiveSession();
/**
* Return the underlying server session
*/
public ServerSession getServerSession();
/**
* This method will return the transactional UnitOfWork during the transaction and null
* outside of the transaction.
*/
public UnitOfWork getUnitOfWork();
/**
* This method will return a Session outside of a transaction and null within a transaction.
*/
public Session getSession();
/**
* This method is used to create a query using a Toplink Expression and the return type.
*/
public javax.persistence.Query createQuery(Expression expression, Class resultType);
}