|
||||||||||
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(Object entity)
Check if the instance belongs to the current persistence context. |
|
Query |
createNamedQuery(String name)
Create an instance of Query for executing a named query (in EJB QL or native SQL). |
|
Query |
createNativeQuery(String sqlString)
Create an instance of Query for executing a native SQL statement, e.g., for update or delete. |
|
Query |
createNativeQuery(String sqlString,
Class resultClass)
Create an instance of Query for executing a native SQL query. |
|
Query |
createNativeQuery(String sqlString,
String resultSetMapping)
Create an instance of Query for executing a native SQL query. |
|
Query |
createQuery(String ejbqlString)
Create an instance of Query for executing an EJB QL statement. |
|
|
find(Class<T> entityClass,
Object primaryKey)
Find by primary key. |
|
void |
flush()
Synchronize the persistence context to the underlying database. |
|
Object |
getDelegate()
Return the underlying provider object for the EntityManager, if available. |
|
FlushModeType |
getFlushMode()
Get the flush mode that applies to all objects contained in the persistence context. |
|
|
getReference(Class<T> entityClass,
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(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(Object entity)
Make an instance managed and persistent. |
|
void |
refresh(Object entity)
Refresh the state of the instance from the database, overwriting changes made to the entity, if any. |
|
void |
remove(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(Object entity)
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 commit
time.)
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)
entity
-
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(Object entity)
entity
-
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(Class<T> entityClass, Object primaryKey)
entityClass
- primaryKey
-
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(Class<T> entityClass, Object primaryKey)
entityClass
- primaryKey
-
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
EntityNotFoundException
- if the entity state
cannot be accessedvoid flush()
TransactionRequiredException
- if there is
no transaction
PersistenceException
- if the flush failsvoid setFlushMode(FlushModeType flushMode)
flushMode
- FlushModeType getFlushMode()
void lock(Object entity, LockModeType lockMode)
entity
- lockMode
-
PersistenceException
- if an unsupported lock call
is made
IllegalArgumentException
- if the instance is not
an entity or is a detached entity
TransactionRequiredException
- if there is no
transactionvoid refresh(Object entity)
entity
-
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(Object entity)
entity
-
IllegalArgumentException
- if not an entityQuery createQuery(String ejbqlString)
ejbqlString
- an EJB QL query string
IllegalArgumentException
- if query string is not validQuery createNamedQuery(String name)
name
- the name of a query defined in metadata
IllegalArgumentException
- if a query has not been
defined with the given nameQuery createNativeQuery(String sqlString)
sqlString
- a native SQL query string
Query createNativeQuery(String sqlString, Class resultClass)
sqlString
- a native SQL query stringresultClass
- the class of the resulting instance(s)
Query createNativeQuery(String sqlString, String resultSetMapping)
sqlString
- a native SQL query stringresultSetMapping
- the name of the result set mapping
void joinTransaction()
TransactionRequiredException
- if there is
no transaction.Object getDelegate()
void close()
IllegalStateException
- if the EntityManager
is container-managed.boolean isOpen()
EntityTransaction getTransaction()
IllegalStateException
- if invoked on a JTA
EntityManager.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |