javax.persistence.EntityManager Maven / Gradle / Ivy
The newest version!
package javax.persistence;
import java.util.Map;
import javax.persistence.criteria.CriteriaBuilder;
import javax.persistence.criteria.CriteriaQuery;
import javax.persistence.metamodel.Metamodel;
/**
* Interface used to interact with the persistence context and to create executable query objects.
*/
public interface EntityManager {
/**
* Clear the persistence context, causing all managed entities to become detached. Changes made to entities that have not been flushed
* to the database will not be persisted.
*/
public void clear();
/**
* Close an application-managed entity manager. After the close method has been invoked, all methods on the EntityManager instance and
* any Query and TypedQuery objects obtained from it will throw the IllegalStateException except for getProperties, getTransaction, and
* isOpen (which will return false). If this method is called when the entity manager is joined to an active transaction, the
* persistence context remains managed until the transaction completes.
*
* @throws IllegalStateException
* if the entity manager is container-managed
*/
public void close();
/**
* Check if the instance is a managed entity instance belonging to the current persistence context.
*
* @param entity
* the entity instance
* @return boolean indicating if entity is in persistence context
* @throws IllegalArgumentException
* if not an entity
*/
public boolean contains(Object entity);
/**
* Create an instance of Query for executing a named query (in the Java Persistence query language or in native SQL).
*
* @param name
* the name of a query defined in metadata
* @return the new query instance
* @throws IllegalArgumentException
* if a query has not been defined with the given name or if the query string is found to be invalid
*/
public Query createNamedQuery(String name);
/**
* Create an instance of TypedQuery for executing a Java Persistence query language named query. The select list of the query must
* contain only a single item, which must be assignable to the type specified by the resultClass argument.[27]
*
* @param name
* the name of a query defined in metadata
* @param resultClass
* the type of the query result
* @param
* query result type
* @return the new query instance
* @throws IllegalArgumentException
* if a query has not been defined with the given name or if the query string is found to be invalid or if the query result
* is found to not be assignable to the specified type
*/
public TypedQuery createNamedQuery(String name, Class resultClass);
/**
* Create an instance of Query for executing a native SQL statement, e.g., for update or delete. If the query is not an update or delete
* query, query execution will result in each row of the SQL result being returned as a result of type Object[] (or a result of type
* Object if there is only one column in the select list.) Column values are returned in the order of their appearance in the select
* list and default JDBC type mappings are applied.
*
* @param sqlString
* a native SQL query string
* @return the new query instance
*/
public Query createNativeQuery(String sqlString);
/**
* Create an instance of Query for executing a native SQL query.
*
* @param sqlString
* a native SQL query string
* @param resultClass
* the class of the resulting instance(s)
* @return the new query instance
*/
public Query createNativeQuery(String sqlString, Class resultClass);
/**
* Create an instance of Query for executing a native SQL query.
*
* @param sqlString
* a native SQL query string
* @param resultSetMapping
* the name of the result set mapping
* @return the new query instance
*/
public Query createNativeQuery(String sqlString, String resultSetMapping);
/**
* Create an instance of TypedQuery for executing a criteria query.
*
* @param criteriaQuery
* a criteria query object
* @param
* query result type
* @return the new query instance
* @throws IllegalArgumentException
* if the criteria query is found to be invalid
*/
public TypedQuery createQuery(CriteriaQuery criteriaQuery);
/**
* Create an instance of Query for executing a Java Persistence query language statement.
*
* @param qlString
* a Java Persistence query string
* @return the new query instance
* @throws IllegalArgumentException
* if the query string is found to be invalid
*/
public Query createQuery(String qlString);
/**
* Create an instance of TypedQuery for executing a Java Persistence query language statement. The select list of the query must contain
* only a single item, which must be assignable to the type specified by the resultClass argument.[26]
*
* @param qlString
* a Java Persistence query string
* @param resultClass
* the type of the query result
* @param
* query result type
* @return the new query instance
* @throws IllegalArgumentException
* if the query string is found to be invalid or if the query result is found to not be assignable to the specified type
*/
public TypedQuery createQuery(String qlString, Class resultClass);
/**
* Remove the given entity from the persistence context, causing a managed entity to become detached. Unflushed changes made to the
* entity if any (including removal of the entity), will not be synchronized to the database. Entities which previously referenced the
* detached entity will continue to reference it.
*
* @param entity
* the entity instance
* @throws IllegalArgumentException
* if the instance is not an entity
*/
public void detach(Object entity);
/**
* Find by primary key. Search for an entity of the specified class and primary key. If the entity instance is contained in the
* persistence context it is returned from there.
*
* @param entityClass
* the class of the entity
* @param primaryKey
* the primary key
* @param
* the object type of the entity
* @return the found entity instance or null if the entity does not exist
* @throws IllegalArgumentException
* if the first argument does not denote an entity type or the second argument is is not a valid type for that entity’s
* primary key or is null
*/
public T find(Class entityClass, Object primaryKey);
/**
* Find by primary key and lock. Search for an entity of the specified class and primary key and lock it with respect to the specified
* lock type. If the entity instance is contained in the persistence context it is returned from there, and the effect of this method is
* the same as if the lock method had been called on the entity. If the entity is found within the persistence context and the lock mode
* type is pessimistic and the entity has a version attribute, the persistence provider must perform optimistic version checks when
* obtaining the database lock. If these checks fail, the OptimisticLockException will be thrown. If the lock mode type is pessimistic
* and the entity instance is found but cannot be locked: - the PessimisticLockException will be thrown if the database locking failure
* causes transaction-level rollback - the LockTimeoutException will be thrown if the database locking failure causes only
* statement-level rollback
*
* @param entityClass
* the class of the entity
* @param primaryKey
* the primary key
* @param lockMode
* the lock mode
* @param
* the object type of the entity
* @return the found entity instance or null if the entity does not exist
* @throws IllegalArgumentException
* if the first argument does not denote an entity type or the second argument is not a valid type for that entity's primary
* key or is null
* @throws TransactionRequiredException
* if there is no transaction and a lock mode other than NONE is specified or if invoked on an entity manager which has not
* been joined to the current transaction and a lock mode other than NONE is specified
* @throws OptimisticLockException
* if the optimistic version check fails
* @throws PessimisticLockException
* if pessimistic locking fails and the transaction is rolled back
* @throws LockTimeoutException
* if pessimistic locking fails and only the statement is rolled back
* @throws PersistenceException
* if an unsupported lock call is made
*/
public T find(Class entityClass, Object primaryKey, LockModeType lockMode);
/**
* Find by primary key and lock, using the specified properties. Search for an entity of the specified class and primary key and lock it
* with respect to the specified lock type. If the entity instance is contained in the persistence context it is returned from there. If
* the entity is found within the persistence context and the lock mode type is pessimistic and the entity has a version attribute, the
* persistence provider must perform optimistic version checks when obtaining the database lock. If these checks fail, the
* OptimisticLockException will be thrown. If the lock mode type is pessimistic and the entity instance is found but cannot be locked: -
* the PessimisticLockException will be thrown if the database locking failure causes transaction-level rollback - the
* LockTimeoutException will be thrown if the database locking failure causes only statement-level rollback If a vendor-specific
* property or hint is not recognized, it is silently ignored. Portable applications should not rely on the standard timeout hint.
* Depending on the database in use and the locking mechanisms used by the provider, the hint may or may not be observed.
*
* @param entityClass
* the class of the entity
* @param primaryKey
* the primary key
* @param lockMode
* the lock mode
* @param properties
* standard and vendor-specific properties and hints
* @param
* the object type of the entity
* @return the found entity instance or null if the entity does not exist
* @throws IllegalArgumentException
* if the first argument does not denote an entity type or the second argument is not a valid type for that entity's primary
* key or is null
* @throws TransactionRequiredException
* if there is no transaction and a lock mode other than NONE is specified or if invoked on an entity manager which has not
* been joined to the current transaction and a lock mode other than NONE is specified
* @throws OptimisticLockException
* if the optimistic version check fails
* @throws PessimisticLockException
* if pessimistic locking fails and the transaction is rolled back
* @throws LockTimeoutException
* if pessimistic locking fails and only the statement is rolled back
* @throws PersistenceException
* if an unsupported lock call is made
*/
public T find(Class entityClass, Object primaryKey, LockModeType lockMode, Map properties);
/**
* Find by primary key, using the specified properties. Search for an entity of the specified class and primary key. If the entity
* instance is contained in the persistence context it is returned from there. If a vendor-specific property or hint is not recognized,
* it is silently ignored.
*
* @param entityClass
* the class of the entity
* @param primaryKey
* the primary key
* @param properties
* standard and vendor-specific properties and hints
* @param
* the object type of the entity
* @return the found entity instance or null if the entity does not exist
* @throws IllegalArgumentException
* if the first argument does not denote an entity type or the second argument is is not a valid type for that entity’s
* primary key or is null
*/
public T find(Class entityClass, Object primaryKey, Map properties);
/**
* Synchronize the persistence context to the underlying database.
*
* @throws TransactionRequiredException
* if there is no transaction or if the entity manager has not been joined to the current transaction
* @throws PersistenceException
* if the flush fails
*/
public void flush();
/**
* Return an instance of CriteriaBuilder for the creation of CriteriaQuery objects.
*
* @return CriteriaBuilder instance
* @throws IllegalStateException
* if the entity manager has been closed
*/
public CriteriaBuilder getCriteriaBuilder();
/**
* Return the underlying provider object for the EntityManager, if available. The result of this method is implementation specific. The
* unwrap method is to be preferred for new applications.
*
* @return underlying provider object for EntityManager
*/
public Object getDelegate();
/**
* Return the entity manager factory for the entity manager.
*
* @return EntityManagerFactory instance
* @throws IllegalStateException
* if the entity manager has been closed
*/
public EntityManagerFactory getEntityManagerFactory();
/**
* Get the flush mode that applies to all objects contained in the persistence context.
*
* @return flushMode
*/
public FlushModeType getFlushMode();
/**
* Get the current lock mode for the entity instance.
*
* @param entity
* the entity instance
* @return lock mode
* @throws TransactionRequiredException
* if there is no transaction or if the entity manager has not been joined to the current transaction
* @throws IllegalArgumentException
* if the instance is not a managed entity and a transaction is active
*/
public LockModeType getLockMode(Object entity);
/**
* Return an instance of Metamodel interface for access to the metamodel of the persistence unit.
*
* @return Metamodel instance
* @throws IllegalStateException
* if the entity manager has been closed
*/
public Metamodel getMetamodel();
/**
* Get the properties and hints and associated values that are in effect for the entity manager. Changing the contents of the map does
* not change the configuration in effect.
*
* @return map of properties and hints in effect
*/
public Map getProperties();
/**
* Get an instance, whose state may be lazily fetched. If the requested instance does not exist in the database, the
* EntityNotFoundException is thrown when the instance state is first accessed. (The persistence provider runtime is permitted to throw
* the EntityNotFoundException when getReference is called.) The application should not expect that the instance state will be available
* upon detachment, unless it was accessed by the application while the entity manager was open.
*
* @param entityClass
* the class of the entity
* @param primaryKey
* the primary key
* @param
* the object type of the entity
* @return the found entity instance
* @throws IllegalArgumentException
* if the first argument does not denote an entity type or the second argument is not a valid type for that entity’s primary
* key or is null
* @throws EntityNotFoundException
* if the entity state cannot be accessed
*/
public T getReference(Class entityClass, Object primaryKey);
/**
* Return the resource-level EntityTransaction object. The EntityTransaction instance may be used serially to begin and commit multiple
* transactions.
*
* @return EntityTransaction instance
* @throws IllegalStateException
* if invoked on a JTA entity manager
*/
public EntityTransaction getTransaction();
/**
* Determine whether the entity manager is joined to the current transaction. Returns false if the entity manager is not joined to the
* current transaction or if no transaction is active
*
* @return boolean
*/
public boolean isJoinedToTransaction();
/**
* Determine whether the entity manager is open.
*
* @return true until the entity manager has been closed
*/
public boolean isOpen();
/**
* Indicate to the entity manager that a JTA transaction is active. This method should be called on a JTA application managed entity
* manager that was created outside the scope of the active transaction or on an entity manager of type
* SynchronizationType.UNSYNCHRONIZED to associate it with the current JTA transaction.
*
* @throws TransactionRequiredException
* if there is no transaction
*/
public void joinTransaction();
/**
* Lock an entity instance that is contained in the persistence context with the specified lock mode type. If a pessimistic lock mode
* type is specified and the entity contains a version attribute, the persistence provider must also perform optimistic version checks
* when obtaining the database lock. If these checks fail, the OptimisticLockException will be thrown. If the lock mode type is
* pessimistic and the entity instance is found but cannot be locked: - the PessimisticLockException will be thrown if the database
* locking failure causes transaction-level rollback - the LockTimeoutException will be thrown if the database locking failure causes
* only statement-level rollback
*
* @param entity
* the entity instance
* @param lockMode
* the lock mode
* @throws IllegalArgumentException
* if the instance is not an entity or is a detached entity
* @throws TransactionRequiredException
* if there is no transaction or if invoked on an entity manager which has not been joined to the current transaction
* @throws EntityNotFoundException
* if the entity does not exist in the database when pessimistic locking is performed
* @throws OptimisticLockException
* if the optimistic version check fails
* @throws PessimisticLockException
* if pessimistic locking fails and the transaction is rolled back
* @throws LockTimeoutException
* if pessimistic locking fails and only the statement is rolled back
* @throws PersistenceException
* if an unsupported lock call is made
*/
public void lock(Object entity, LockModeType lockMode);
/**
* Lock an entity instance that is contained in the persistence context with the specified lock mode type and with specified properties.
* If a pessimistic lock mode type is specified and the entity contains a version attribute, the persistence provider must also perform
* optimistic version checks when obtaining the database lock. If these checks fail, the OptimisticLockException will be thrown. If the
* lock mode type is pessimistic and the entity instance is found but cannot be locked: - the PessimisticLockException will be thrown if
* the database locking failure causes transaction-level rollback - the LockTimeoutException will be thrown if the database locking
* failure causes only statement-level rollback If a vendor-specific property or hint is not recognized, it is silently ignored.
* Portable applications should not rely on the standard timeout hint. Depending on the database in use and the locking mechanisms used
* by the provider, the hint may or may not be observed.
*
* @param entity
* the entity instance
* @param lockMode
* the lock mode
* @param properties
* standard and vendor-specific properties and hints
* @throws IllegalArgumentException
* if the instance is not an entity or is a detached entity
* @throws TransactionRequiredException
* if there is no transaction or if invoked on an entity manager which has not been joined to the current transaction
* @throws EntityNotFoundException
* if the entity does not exist in the database when pessimistic locking is performed
* @throws OptimisticLockException
* if the optimistic version check fails
* @throws PessimisticLockException
* if pessimistic locking fails and the transaction is rolled back
* @throws LockTimeoutException
* if pessimistic locking fails and only the statement is rolled back
* @throws PersistenceException
* if an unsupported lock call is made
*/
public void lock(Object entity, LockModeType lockMode, Map properties);
/**
* Merge the state of the given entity into the current persistence context.
*
* @param entity
* the entity instance
* @param
* the object type of the entity
* @return the managed instance that the state was merged to
* @throws IllegalArgumentException
* if instance is not an entity or is a removed entity
* @throws TransactionRequiredException
* if there is no transaction when invoked on a container-managed entity manager that is of type
* PersistenceContextType.TRANSACTION.
*/
public T merge(T entity);
/**
* Make an instance managed and persistent.
*
* @param entity
* the entity instance
* @throws EntityExistsException
* if the entity already exists. (If the entity already exists, the EntityExistsException may be thrown when the persist
* operation is invoked, or the EntityExistsException or another PersistenceException may be thrown at flush or commit
* time.)
* @throws IllegalArgumentException
* if the instance is not an entity
* @throws TransactionRequiredException
* if there is no transaction when invoked on a container-managed entity manager that is of type
* PersistenceContextType.TRANSACTION.
*/
public void persist(Object entity);
/**
* Refresh the state of the instance from the database, overwriting changes made to the entity, if any.
*
* @param entity
* the entity instance
* @throws IllegalArgumentException
* if the instance is not an entity or the entity is not managed
* @throws TransactionRequiredException
* if there is no transaction when invoked on a container-managed entity manager that is of type
* PersistenceContextType.TRANSACTION.
* @throws EntityNotFoundException
* if the entity no longer exists in the database
*/
public void refresh(Object entity);
/**
* Refresh the state of the instance from the database, overwriting changes made to the entity, if any, and lock it with respect to
* given lock mode type. If the lock mode type is pessimistic and the entity instance is found but cannot be locked: - the
* PessimisticLockException will be thrown if the database locking failure causes transaction-level rollback - the LockTimeoutException
* will be thrown if the database locking failure causes only statement-level rollback.
*
* @param entity
* the entity instance
* @param lockMode
* the lock mode
* @throws IllegalArgumentException
* if the instance is not an entity or the entity is not managed
* @throws TransactionRequiredException
* if invoked on an entity manager of type PersistenceContextType.TRANSACTION when there is no transaction; if invoked on an
* extended entity manager when there is no transaction and a lock mode other than NONE has been specified; or if invoked on
* an extended entity manager that has not been joined to the current transaction and a lock mode other than NONE has been
* specified
* @throws EntityNotFoundException
* if the entity no longer exists in the database
* @throws PessimisticLockException
* if pessimistic locking fails and the transaction is rolled back
* @throws LockTimeoutException
* if pessimistic locking fails and only the statement is rolled back
* @throws PersistenceException
* if an unsupported lock call is made
*/
public void refresh(Object entity, LockModeType lockMode);
/**
* Refresh the state of the instance from the database, overwriting changes made to the entity, if any, and lock it with respect to
* given lock mode type and with specified properties. If the lock mode type is pessimistic and the entity instance is found but cannot
* be locked: - the PessimisticLockException will be thrown if the database locking failure causes transaction-level rollback - the
* LockTimeoutException will be thrown if the database locking failure causes only statement-level rollback If a vendor-specific
* property or hint is not recognized, it is silently ignored. Portable applications should not rely on the standard timeout hint.
* Depending on the database in use and the locking mechanisms used by the provider, the hint may or may not be observed.
*
* @param entity
* the entity instance
* @param lockMode
* the lock mode
* @param properties
* standard and vendor-specific properties and hints
* @throws IllegalArgumentException
* if the instance is not an entity or the entity is not managed
* @throws TransactionRequiredException
* if invoked on an entity manager of type PersistenceContextType.TRANSACTION when there is no transaction; if invoked on an
* extended entity manager when there is no transaction and a lock mode other than NONE has been specified; or if invoked on
* an extended entity manager that has not been joined to the current transaction and a lock mode other than NONE has been
* specified
* @throws EntityNotFoundException
* if the entity no longer exists in the database
* @throws PessimisticLockException
* if pessimistic locking fails and the transaction is rolled back
* @throws LockTimeoutException
* if pessimistic locking fails and only the statement is rolled back
* @throws PersistenceException
* if an unsupported lock call is made
*/
public void refresh(Object entity, LockModeType lockMode, Map properties);
/**
* Refresh the state of the instance from the database, using the specified properties, and overwriting changes made to the entity, if
* any. If a vendor-specific property or hint is not recognized, it is silently ignored.
*
* @param entity
* the entity instance
* @param properties
* standard and vendor-specific properties and hints
* @throws IllegalArgumentException
* if the instance is not an entity or the entity is not managed
* @throws TransactionRequiredException
* if there is no transaction when invoked on a container-managed entity manager that is of type
* PersistenceContextType.TRANSACTION.
* @throws EntityNotFoundException
* if the entity no longer exists in the database
*/
public void refresh(Object entity, Map properties);
/**
* Remove the entity instance.
*
* @param entity
* the entity instance
* @throws IllegalArgumentException
* if the instance is not an entity or is a detached entity
* @throws TransactionRequiredException
* if there is no transaction when invoked on a container-managed entity manager that is of type
* PersistenceContextType.TRANSACTION.
*/
public void remove(Object entity);
/**
* Set the flush mode that applies to all objects contained in the persistence context.
*
* @param flushMode
* the flush mode
*/
public void setFlushMode(FlushModeType flushMode);
/**
* Set an entity manager property or hint. If a vendor-specific property or hint is not recognized, it is silently ignored.
*
* @param propertyName
* name of property or hint
* @param value
* the value of the property or hint
* @throws IllegalArgumentException
* if the second argument is not valid for the implementation
*/
public void setProperty(String propertyName, Object value);
/**
* Return an object of the specified type to allow access to the provider-specific API. If the provider's EntityManager implementation
* does not support the specified class, the PersistenceException is thrown.
*
* @param cls
* the class of the object to be returned. This is normally either the underlying EntityManager implementation class or an
* interface that it implements.
* @param
* type of the class
* @return an instance of the specified class
* @throws PersistenceException
* if the provider does not support the call
*/
public T unwrap(Class cls);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy