File Doc Category Size Date Package
WrapperPolicy.java API Doc Glassfish v2 API 4380 Tue May 22 16:54:16 BST 2007 oracle.toplink.essentials.descriptors

WrapperPolicy

public interface WrapperPolicy implements Serializable

Purpose: The wrapper policy can be used to wrap all objects read from the database in another object. This allows for TopLink to utilize one version of the class for its purposes and allows for the application to deal with another version of the object. The wrapper policy is used for things such as EJB Entity Beans and is directly used by the TopLink for WebLogic product for EJB Container Managed Persistence. It is assumed that relationships must be through the wrapper objects. Object identity is not maintained on the wrapper objects, only the wrapped object.

Fields Summary
Constructors Summary
Methods Summary
public void initialize(oracle.toplink.essentials.internal.sessions.AbstractSession session)
PUBLIC: Required: Lets the policy perform initialization.
param
session the session to initialize against
public boolean isTraversable()
PUBLIC: Required: Return true if the wrapped value should be traversed. Normally the wrapped value is looked after independently, it is not required to be traversed.
public boolean isWrapped(java.lang.Object object)
PUBLIC: Required: Return true if the object is already wrapped.
public void setDescriptor(oracle.toplink.essentials.descriptors.ClassDescriptor descriptor)
PUBLIC: Required: Set the descriptor.
param
descriptor the descriptor for the object being wrapped
public java.lang.Object unwrapObject(java.lang.Object proxy, oracle.toplink.essentials.internal.sessions.AbstractSession session)
PUBLIC: Required: Unwrap the object to return the implementation that is meant to be used by TopLink. The object may already be unwrapped in which case the object should be returned.
param
proxy the wrapped object
param
session the session to unwrap into
public java.lang.Object wrapObject(java.lang.Object original, oracle.toplink.essentials.internal.sessions.AbstractSession session)
PUBLIC: Required: Wrap the object to return the implementation that the application requires. The object may already be wrapped in which case the object should be returned.
param
original, the object to be wrapped
param
session the session to wrap the object against.
return
java.lang.Object the wrapped object