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 java.util.Collection;
40: import oracle.toplink.essentials.queryframework.DatabaseQuery;
41:
42: /**
43: * PUBLIC:
44: * TopLInk specific EJB 3.0 query interface. Provides the functionality defined in
45: * javax.persistence.Query and adds access to the underlying database query for TopLink specific
46: * functionality.
47: */
48: public interface EJBQuery extends javax.persistence.Query {
49:
50: /**
51: * PUBLIC:
52: * Return the cached database query for this EJBQueryImpl. If the query is
53: * a named query and it has not yet been looked up, the query will be looked up
54: * and stored as the cached query.
55: */
56: public DatabaseQuery getDatabaseQuery();
57:
58: /**
59: * PUBLIC:
60: * return the EntityManager for this query
61: */
62: public EntityManager getEntityManager();
63:
64: /**
65: * PUBLIC:
66: * Non-standard method to return results of a ReadQuery that has a containerPoliry
67: * that returns objects as a collection rather than a List
68: * @return Collection of results
69: */
70: public Collection getResultCollection();
71:
72: /**
73: * PUBLIC:
74: * Replace the cached query with the given query.
75: */
76: public void setDatabaseQuery(DatabaseQuery query);
77:
78: }
|