TopLinkQueryHints


1   /*
2    * The contents of this file are subject to the terms 
3    * of the Common Development and Distribution License 
4    * (the "License").  You may not use this file except 
5    * in compliance with the License.
6    * 
7    * You can obtain a copy of the license at 
8    * glassfish/bootstrap/legal/CDDLv1.0.txt or 
9    * https://glassfish.dev.java.net/public/CDDLv1.0.html. 
10   * See the License for the specific language governing 
11   * permissions and limitations under the License.
12   * 
13   * When distributing Covered Code, include this CDDL 
14   * HEADER in each file and include the License file at 
15   * glassfish/bootstrap/legal/CDDLv1.0.txt.  If applicable, 
16   * add the following below this CDDL HEADER, with the 
17   * fields enclosed by brackets "[]" replaced with your 
18   * own identifying information: Portions Copyright [yyyy] 
19   * [name of copyright owner]
20   */
21  // Copyright (c) 1998, 2006, Oracle. All rights reserved.  
22  package oracle.toplink.essentials.config;
23  
24  /**
25   * 
26   * The class defines TopLink query hints' names.
27   * 
28   * JPA Query Hint Usage:
29   * 
30   * query.setHint(TopLinkQueryHints.CACHE_USAGE, CacheUsage.CheckCacheOnly);
31   * or 
32   * @QueryHint(name=TopLinkQueryHints.CACHE_USAGE, value=CacheUsage.CheckCacheOnly)
33   * 
34   * Hint values are case-insensitive; "" could be used instead of default value.
35   * 
36   * @see HintValues
37   * @see CacheUsage
38   * @see PessimisticLock
39   */
40  public class TopLinkQueryHints {
41     /**
42      * Valid values are:  HintValues.PERSISTENCE_UNIT_DEFAULT, HintValues.TRUE, HintValues.FALSE
43      * "" could be used instead of default value HintValues.PERSISTENCE_UNIT_DEFAULT
44      */
45      public static final String   BIND_PARAMETERS = "toplink.jdbc.bind-parameters";
46  
47     /**
48      * Valid values are all declared in CacheUsage class.
49      */
50      public static final String   CACHE_USAGE = "toplink.cache-usage";
51      
52     /**
53      * Valid values are all declared in PessimisticLock class.
54      */
55      public static final String   PESSIMISTIC_LOCK = "toplink.pessimistic-lock";
56      
57     /**
58      * Valid values are:  HintValues.FALSE, HintValues.TRUE
59      * "" could be used instead of default value HintValues.FALSE
60      */
61      public static final String   REFRESH = "toplink.refresh";
62  }
63
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags