oracle.toplink.essentials.indirection.IndirectContainer 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, 2007, Oracle. All rights reserved.
package oracle.toplink.essentials.indirection;
/**
* Purpose:
* Define an interface for a Container that can also act as a TopLink
* "indirection" object; i.e. the Container will only read its contents from
* the database when necessary (typically, on receipt of the first
* Container-related message).
*
*
* @see oracle.toplink.essentials.internal.indirection.TransparentIndirectionPolicy
* @author Big Country
* @since TOPLink/Java 2.5
*/
public interface IndirectContainer {
/**
* PUBLIC:
* This is used by the indirection policy to build the
* UOW clone of the container.
* @return oracle.toplink.essentials.indirection.ValueHolderInterface A representation of the valueholder * which this container uses
*/
public ValueHolderInterface getValueHolder();
/**
* PUBLIC:
* Return whether the contents have been read from the database.
* This is used periodically by the indirection policy to determine whether
* to trigger the database read.
*/
public boolean isInstantiated();
/**
* PUBLIC:
* Set the valueHolder.
* This is used by the indirection policy to build the
* UOW clone of the container.
*/
public void setValueHolder(ValueHolderInterface valueHolder);
}