|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EntityManager
Interface used to interact with the persistence context.
Method Summary | ||
---|---|---|
void |
clear()
Clear the persistence context, causing all managed entities to become detached. |
|
void |
close()
Close an application-managed EntityManager. |
|
boolean |
contains(java.lang.Object entity)
Check if the instance belongs to the current persistence context. |
|
Query |
createNamedQuery(java.lang.String name)
Create an instance of Query for executing a named query (in the Java Persistence query language or in native SQL). |
|
Query |
createNativeQuery(java.lang.String sqlString)
Create an instance of Query for executing a native SQL statement, e.g., for update or delete. |
|
Query |
createNativeQuery(java.lang.String sqlString,
java.lang.Class resultClass)
Create an instance of Query for executing a native SQL query. |
|
Query |
createNativeQuery(java.lang.String sqlString,
java.lang.String resultSetMapping)
Create an instance of Query for executing a native SQL query. |
|
Query |
createQuery(java.lang.String qlString)
Create an instance of Query for executing a Java Persistence query language statement. |
|
|
find(java.lang.Class<T> entityClass,
java.lang.Object primaryKey)
Find by primary key. |
|
void |
flush()
Synchronize the persistence context to the underlying database. |
|
java.lang.Object |
getDelegate()
|
|
FlushModeType |
getFlushMode()
Get the flush mode that applies to all objects contained in the persistence context. |
|
|
getReference(java.lang.Class<T> entityClass,
java.lang.Object primaryKey)
Get an instance, whose state may be lazily fetched. |
|
EntityTransaction |
getTransaction()
Return the resource-level transaction object. |
|
boolean |
isOpen()
Determine whether the EntityManager is open. |
|
void |
joinTransaction()
Indicate to the EntityManager that a JTA transaction is active. |
|
void |
lock(java.lang.Object entity,
LockModeType lockMode)
Set the lock mode for an entity object contained in the persistence context. |
|
|
merge(T entity)
Merge the state of the given entity into the current persistence context. |
|
void |
persist(java.lang.Object entity)
Make an instance managed and persistent. |
|
void |
refresh(java.lang.Object entity)
Refresh the state of the instance from the database, overwriting changes made to the entity, if any. |
|
void |
remove(java.lang.Object entity)
Remove the entity instance. |
|
void |
setFlushMode(FlushModeType flushMode)
Set the flush mode that applies to all objects contained in the persistence context. |
Method Detail |
---|
void persist(java.lang.Object entity)
entity
- the given entity.
EntityExistsException
- 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.)
java.lang.IllegalArgumentException
- if not an entity
TransactionRequiredException
- if invoked on a container-managed
entity manager of type PersistenceContextType.TRANSACTION and
there is no transaction.<T> T merge(T entity)
T
- The class of the entity.entity
- the given entity.
java.lang.IllegalArgumentException
- if instance is not an entity or is a
removed entity
TransactionRequiredException
- if invoked on a container-managed
entity manager of type PersistenceContextType.TRANSACTION and
there is no transaction.void remove(java.lang.Object entity)
entity
- the given entity.
java.lang.IllegalArgumentException
- if not an entity or if a detached entity
TransactionRequiredException
- if invoked on a container-managed
entity manager of type PersistenceContextType.TRANSACTION and
there is no transaction.<T> T find(java.lang.Class<T> entityClass, java.lang.Object primaryKey)
T
- The class of the entity.entityClass
- the entity class.primaryKey
- the primary key.
java.lang.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<T> T getReference(java.lang.Class<T> entityClass, java.lang.Object primaryKey)
T
- The class of the entity.entityClass
- the entity class.primaryKey
- the primary key.
void flush()
TransactionRequiredException
- if there is no transaction
PersistenceException
- if the flush failsvoid setFlushMode(FlushModeType flushMode)
flushMode
- the given flush mode.FlushModeType getFlushMode()
void lock(java.lang.Object entity, LockModeType lockMode)
entity
- the given entity.lockMode
- the lock mode.
PersistenceException
- if an unsupported lock call is made
java.lang.IllegalArgumentException
- if the instance is not an entity or is a
detached entity
TransactionRequiredException
- if there is no transactionvoid refresh(java.lang.Object entity)
entity
- the given entity.
java.lang.IllegalArgumentException
- if not an entity or entity is not
managed
TransactionRequiredException
- if invoked on a container-managed
entity manager of type PersistenceContextType.TRANSACTION and
there is no transaction.
EntityNotFoundException
- if the entity no longer exists in the
databasevoid clear()
boolean contains(java.lang.Object entity)
entity
- the given entity
java.lang.IllegalArgumentException
- if not an entityQuery createQuery(java.lang.String qlString)
qlString
- a Java Persistence query string
java.lang.IllegalArgumentException
- if query string is not validQuery createNamedQuery(java.lang.String name)
name
- the name of a query defined in metadata
java.lang.IllegalArgumentException
- if a query has not been defined with the
given nameQuery createNativeQuery(java.lang.String sqlString)
sqlString
- a native SQL query string
Query createNativeQuery(java.lang.String sqlString, java.lang.Class resultClass)
sqlString
- a native SQL query stringresultClass
- the class of the resulting instance(s)
Query createNativeQuery(java.lang.String sqlString, java.lang.String resultSetMapping)
sqlString
- a native SQL query stringresultSetMapping
- the name of the result set mapping
void joinTransaction()
TransactionRequiredException
- if there is no transaction.java.lang.Object getDelegate()
void close()
java.lang.IllegalStateException
- if the EntityManager is container-managed.boolean isOpen()
EntityTransaction getTransaction()
java.lang.IllegalStateException
- if invoked on a JTA EntityManager.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |