javax.persistence.PersistenceUtil Maven / Gradle / Ivy

Go to download
package javax.persistence;

/**
 * Utility interface between the application and the persistence provider(s).
 * 
 * The PersistenceUtil interface instance obtained from the Persistence class is used to determine the load state of an entity or entity
 * attribute regardless of which persistence provider in the environment created the entity.
 */
public interface PersistenceUtil {
	/**
	 * Determine the load state of an entity. This method can be used to determine the load state of an entity passed as a reference. An
	 * entity is considered loaded if all attributes for which FetchType EAGER has been specified have been loaded. The isLoaded(Object,
	 * String) method should be used to determine the load state of an attribute. Not doing so might lead to unintended loading of state.
	 * 
	 * @param entity
	 *            whose load state is to be determined
	 * @return false if the entity has not been loaded, else true
	 */
	public boolean isLoaded(Object entity);

	/**
	 * Determine the load state of a given persistent attribute.
	 * 
	 * @param entity
	 *            containing the attribute
	 * @param attributeName
	 *            name of attribute whose load state is to be determined
	 * @return false if entity's state has not been loaded or if the attribute state has not been loaded, else true
	 */
	public boolean isLoaded(Object entity, String attributeName);
}