oracle.toplink.indirection
Interface IndirectContainer

All Known Implementing Classes:

IndirectList, IndirectMap, IndirectSet

public interface IndirectContainer

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).

Since:

TOPLink/Java 2.5

See Also:

oracle.toplink.mappings.TransparentIndirectionPolicy

Method Summary

Type	Method
ValueHolderInterface	getValueHolder() PUBLIC: This is used by the indirection policy to build the UOW clone of the container.
boolean	isInstantiated() PUBLIC: Return whether the contents have been read from the database.
void	setValueHolder(ValueHolderInterface valueHolder) PUBLIC: Set the valueHolder.

Method Detail

getValueHolder

public ValueHolderInterface getValueHolder()

PUBLIC: This is used by the indirection policy to build the UOW clone of the container.

Returns:

oracle.toplink.indirection.ValueHolderInterface A representation of the valueholder * which this container uses

isInstantiated

public boolean isInstantiated()

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.

setValueHolder

public void setValueHolder(ValueHolderInterface valueHolder)

PUBLIC: Set the valueHolder. This is used by the indirection policy to build the UOW clone of the container.