KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > oracle > toplink > essentials > queryframework > FetchGroupTracker


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, 2005, Oracle. All rights reserved.
22 package oracle.toplink.essentials.queryframework;
23
24 /**
25  * <p><b>Purpose</b>: The fetch group tracker interface provides a set of APIs which
26  * the domain object must implement, in order to take advantage of the TopLink fetch group
27  * performance enhancement feature.
28  *
29  * @see oracle.toplink.essentials.queryframework.FetchGroup
30  *
31  * @author King Wang
32  * @since TopLink 10.1.3
33  */
34 public interface FetchGroupTracker {
35
36     /**
37      * Return the fetch group being tracked
38      */
39     FetchGroup getFetchGroup();
40
41     /**
42      * Set a fetch group to be tracked.
43      */
44     void setFetchGroup(FetchGroup group);
45
46     /**
47      * Return true if the attribute is in the fetch group being tracked.
48      */
49     boolean isAttributeFetched(String JavaDoc attribute);
50
51     /**
52      * Reset all attributes of the tracked object to the unfetched state with initial default values.
53      */
54     void resetFetchGroup();
55
56     /**
57      * Return true if the fecth group attributes should be refreshed
58      */
59     boolean shouldRefreshFetchGroup();
60
61     /**
62      * Set true if the fecth group attributes should be refreshed
63      */
64     void setShouldRefreshFetchGroup(boolean shouldRefreshFetchGroup);
65 }
66
Popular Tags