oracle.toplink.essentials.queryframework.FetchGroupTracker Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the "License"). You may not use this file except
* in compliance with the License.
*
* You can obtain a copy of the license at
* glassfish/bootstrap/legal/CDDLv1.0.txt or
* https://glassfish.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* HEADER in each file and include the License file at
* glassfish/bootstrap/legal/CDDLv1.0.txt. If applicable,
* add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your
* own identifying information: Portions Copyright [yyyy]
* [name of copyright owner]
*/
// Copyright (c) 1998, 2005, Oracle. All rights reserved.
package oracle.toplink.essentials.queryframework;
/**
* Purpose: The fetch group tracker interface provides a set of APIs which
* the domain object must implement, in order to take advantage of the TopLink fetch group
* performance enhancement feature.
*
* @see oracle.toplink.essentials.queryframework.FetchGroup
*
* @author King Wang
* @since TopLink 10.1.3
*/
public interface FetchGroupTracker {
/**
* Return the fetch group being tracked
*/
FetchGroup getFetchGroup();
/**
* Set a fetch group to be tracked.
*/
void setFetchGroup(FetchGroup group);
/**
* Return true if the attribute is in the fetch group being tracked.
*/
boolean isAttributeFetched(String attribute);
/**
* Reset all attributes of the tracked object to the unfetched state with initial default values.
*/
void resetFetchGroup();
/**
* Return true if the fecth group attributes should be refreshed
*/
boolean shouldRefreshFetchGroup();
/**
* Set true if the fecth group attributes should be refreshed
*/
void setShouldRefreshFetchGroup(boolean shouldRefreshFetchGroup);
}