Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
EnhancedOQLQuery |
|
| 1.0;1 |
1 | package org.apache.ojb.odmg.oql; | |
2 | ||
3 | /* Copyright 2002-2005 The Apache Software Foundation | |
4 | * | |
5 | * Licensed under the Apache License, Version 2.0 (the "License"); | |
6 | * you may not use this file except in compliance with the License. | |
7 | * You may obtain a copy of the License at | |
8 | * | |
9 | * http://www.apache.org/licenses/LICENSE-2.0 | |
10 | * | |
11 | * Unless required by applicable law or agreed to in writing, software | |
12 | * distributed under the License is distributed on an "AS IS" BASIS, | |
13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
14 | * See the License for the specific language governing permissions and | |
15 | * limitations under the License. | |
16 | */ | |
17 | ||
18 | import org.odmg.OQLQuery; | |
19 | import org.odmg.QueryInvalidException; | |
20 | ||
21 | /** | |
22 | * Offers useful none odmg-standard methods of the odmg {@link org.odmg.OQLQuery} interface. | |
23 | * <p> | |
24 | * Note: All listed methods are <strong>not</strong> part of the standard ODMG-api - | |
25 | * they are special (proprietary) OJB extensions. | |
26 | * </p> | |
27 | * | |
28 | * @version $Id: EnhancedOQLQuery.java,v 1.1 2007-08-24 22:17:36 ewestfal Exp $ | |
29 | */ | |
30 | public interface EnhancedOQLQuery extends OQLQuery | |
31 | { | |
32 | /** | |
33 | * An extension of the {@link org.odmg.OQLQuery#create(String)} method, which | |
34 | * additionally allow to specify an <em>start-</em> and <em>end-Index</em> for | |
35 | * the query. | |
36 | * | |
37 | * @param queryString An oql query string. | |
38 | * @param startAtIndex The start index. | |
39 | * @param endAtIndex The end index. | |
40 | * @throws QueryInvalidException The type of the parameter does | |
41 | * not correspond with the type of the parameter in the query. | |
42 | */ | |
43 | void create(String queryString, int startAtIndex, int endAtIndex) throws QueryInvalidException; | |
44 | ||
45 | /** | |
46 | * Deprecated method. | |
47 | * @deprecated | |
48 | */ | |
49 | int fullSize(); | |
50 | } |