Summary: Methods | Inherited Methods | [Expand All]

public interface

Session

implements Session

org.hibernate.classic.Session

Known Indirect Subclasses

SessionImpl

Class Overview

An extension of the Session API, including all deprecated methods from Hibernate2. This interface is provided to allow easier migration of existing applications. New code should use org.hibernate.Session.

Summary

Public Methods
abstract Query	createSQLQuery(String sql, String returnAlias, Class returnClass) This method is deprecated. use `addRoot(String, Class)` or `addEntity(Class)` variants instead to define the alias/class
abstract Query	createSQLQuery(String sql, String[] returnAliases, Class[] returnClasses) This method is deprecated. use `addRoot(String, Class)` or `addEntity(Class)` variants instead to define the aliases/classes
abstract int	delete(String query) This method is deprecated. consider using HQL delete statements
abstract int	delete(String query, Object[] values, Type[] types) This method is deprecated. consider using HQL delete statements
abstract int	delete(String query, Object value, Type type) This method is deprecated. consider using HQL delete statements
abstract Collection	filter(Object collection, String filter, Object value, Type type) This method is deprecated. use `createFilter(Object, String)`.setXYZ.`list()`
abstract Collection	filter(Object collection, String filter, Object[] values, Type[] types) This method is deprecated. use `createFilter(Object, String)`.setXYZ.`list()`
abstract Collection	filter(Object collection, String filter) This method is deprecated. use `createFilter(Object, String)`.`list()`
abstract List	find(String query, Object value, Type type) This method is deprecated. use `createQuery(String)`.setXYZ.`list()`
abstract List	find(String query) This method is deprecated. use `createQuery(String)`.`list()`
abstract List	find(String query, Object[] values, Type[] types) This method is deprecated. use `createQuery(String)`.setXYZ.`list()`
abstract Iterator	iterate(String query, Object[] values, Type[] types) This method is deprecated. use `createQuery(String)`.setXYZ.`iterate()`
abstract Iterator	iterate(String query) This method is deprecated. use `createQuery(String)`.`iterate()`
abstract Iterator	iterate(String query, Object value, Type type) This method is deprecated. use `createQuery(String)`.setXYZ.`iterate()`
abstract void	save(Object object, Serializable id) This method is deprecated. declare identifier properties for all classes
abstract void	save(String entityName, Object object, Serializable id) This method is deprecated. declare identifier properties for all classes
abstract Object	saveOrUpdateCopy(String entityName, Object object, Serializable id) This method is deprecated. with no replacement
abstract Object	saveOrUpdateCopy(Object object, Serializable id) This method is deprecated. with no replacement
abstract Object	saveOrUpdateCopy(Object object) This method is deprecated. use `merge(Object)`
abstract Object	saveOrUpdateCopy(String entityName, Object object) This method is deprecated. use `merge(String, Object)`
abstract void	update(Object object, Serializable id) This method is deprecated. declare identifier properties for all classes
abstract void	update(String entityName, Object object, Serializable id) This method is deprecated. declare identifier properties for all classes

[Expand]

Inherited Methods

From interface org.hibernate.Session

abstract Transaction	beginTransaction() Begin a unit of work and return the associated `Transaction` object.
abstract Session.LockRequest	buildLockRequest(LockOptions lockOptions) Build a LockRequest that specifies the LockMode, pessimistic lock timeout and lock scope.
abstract void	cancelQuery() Cancel the execution of the current query.
abstract void	clear() Completely clear the session.
abstract Connection	close() End the session by releasing the JDBC connection and cleaning up.
abstract Connection	connection() This method is deprecated. (scheduled for removal in 4.x). Replacement depends on need; for doing direct JDBC stuff use `doWork(Work)`; for opening a 'temporary Session' use (TBD).
abstract boolean	contains(Object object) Check if this instance is associated with this `Session`.
abstract Criteria	createCriteria(String entityName) Create a new `Criteria` instance, for the given entity name.
abstract Criteria	createCriteria(String entityName, String alias) Create a new `Criteria` instance, for the given entity name, with the given alias.
abstract Criteria	createCriteria(Class persistentClass) Create a new `Criteria` instance, for the given entity class, or a superclass of an entity class.
abstract Criteria	createCriteria(Class persistentClass, String alias) Create a new `Criteria` instance, for the given entity class, or a superclass of an entity class, with the given alias.
abstract Query	createFilter(Object collection, String queryString) Create a new instance of `Query` for the given collection and filter string.
abstract Query	createQuery(String queryString) Create a new instance of `Query` for the given HQL query string.
abstract SQLQuery	createSQLQuery(String queryString) Create a new instance of `SQLQuery` for the given SQL query string.
abstract void	delete(String entityName, Object object) Remove a persistent instance from the datastore.
abstract void	delete(Object object) Remove a persistent instance from the datastore.
abstract void	disableFetchProfile(String name) Disable a particular fetch profile on this session.
abstract void	disableFilter(String filterName) Disable the named filter for the current session.
abstract Connection	disconnect() Disconnect the `Session` from the current JDBC connection.
abstract void	doWork(Work work) Controller for allowing users to perform JDBC related work using the Connection managed by this Session.
abstract void	enableFetchProfile(String name) Enable a particular fetch profile on this session.
abstract Filter	enableFilter(String filterName) Enable the named filter for this current session.
abstract void	evict(Object object) Remove this instance from the session cache.
abstract void	flush() Force this session to flush.
abstract Object	get(String entityName, Serializable id, LockMode lockMode) This method is deprecated. LockMode parameter should be replaced with LockOptions
abstract Object	get(Class clazz, Serializable id, LockOptions lockOptions) Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance.
abstract Object	get(Class clazz, Serializable id, LockMode lockMode) This method is deprecated. LockMode parameter should be replaced with LockOptions
abstract Object	get(String entityName, Serializable id) Return the persistent instance of the given named entity with the given identifier, or null if there is no such persistent instance.
abstract Object	get(String entityName, Serializable id, LockOptions lockOptions) Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance.
abstract Object	get(Class clazz, Serializable id) Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance.
abstract CacheMode	getCacheMode() Get the current cache mode.
abstract LockMode	getCurrentLockMode(Object object) Determine the current lock mode of the given object.
abstract Filter	getEnabledFilter(String filterName) Retrieve a currently enabled filter by name.
abstract EntityMode	getEntityMode() Retrieve the entity mode in effect for this session.
abstract String	getEntityName(Object object) Return the entity name for a persistent entity
abstract FlushMode	getFlushMode() Get the current flush mode for this session.
abstract Serializable	getIdentifier(Object object) Return the identifier value of the given entity as associated with this session.
abstract LobHelper	getLobHelper() Retrieve this session's helper/delegate for creating LOB instances.
abstract Query	getNamedQuery(String queryName) Obtain an instance of `Query` for a named query string defined in the mapping file.
abstract Session	getSession(EntityMode entityMode) Starts a new Session with the given entity mode in effect.
abstract SessionFactory	getSessionFactory() Get the session factory which created this session.
abstract SessionStatistics	getStatistics() Get the statistics for this session.
abstract Transaction	getTransaction() Get the `Transaction` instance associated with this session.
abstract TypeHelper	getTypeHelper() Convenience access to the `TypeHelper` associated with this session's `SessionFactory`.
abstract boolean	isConnected() Check if the session is currently connected.
abstract boolean	isDefaultReadOnly() Will entities and proxies that are loaded into this session be made read-only by default? To determine the read-only/modifiable setting for a particular entity or proxy:
abstract boolean	isDirty() Does this session contain any changes which must be synchronized with the database? In other words, would any DML operations be executed if we flushed this session?
abstract boolean	isFetchProfileEnabled(String name) Is a particular fetch profile enabled on this session?
abstract boolean	isOpen() Check if the session is still open.
abstract boolean	isReadOnly(Object entityOrProxy) Is the specified entity or proxy read-only? To get the default read-only/modifiable setting used for entities and proxies that are loaded into the session:
abstract void	load(Object object, Serializable id) Read the persistent state associated with the given identifier into the given transient instance.
abstract Object	load(Class theClass, Serializable id, LockMode lockMode) This method is deprecated. LockMode parameter should be replaced with LockOptions
abstract Object	load(Class theClass, Serializable id) Return the persistent instance of the given entity class with the given identifier, assuming that the instance exists.
abstract Object	load(String entityName, Serializable id) Return the persistent instance of the given entity class with the given identifier, assuming that the instance exists.
abstract Object	load(String entityName, Serializable id, LockOptions lockOptions) Return the persistent instance of the given entity class with the given identifier, obtaining the specified lock mode, assuming the instance exists.
abstract Object	load(String entityName, Serializable id, LockMode lockMode) This method is deprecated. LockMode parameter should be replaced with LockOptions
abstract Object	load(Class theClass, Serializable id, LockOptions lockOptions) Return the persistent instance of the given entity class with the given identifier, obtaining the specified lock mode, assuming the instance exists.
abstract void	lock(String entityName, Object object, LockMode lockMode) This method is deprecated. instead call buildLockRequest(LockMode).lock(entityName, object)
abstract void	lock(Object object, LockMode lockMode) This method is deprecated. instead call buildLockRequest(LockMode).lock(object)
abstract Object	merge(Object object) Copy the state of the given object onto the persistent object with the same identifier.
abstract Object	merge(String entityName, Object object) Copy the state of the given object onto the persistent object with the same identifier.
abstract void	persist(Object object) Make a transient instance persistent.
abstract void	persist(String entityName, Object object) Make a transient instance persistent.
abstract void	reconnect() This method is deprecated. Manual reconnection is only needed in the case of application-supplied connections, in which case the `reconnect(java.sql.Connection)` for should be used.
abstract void	reconnect(Connection connection) Reconnect to the given JDBC connection.
abstract void	refresh(Object object, LockMode lockMode) This method is deprecated. LockMode parameter should be replaced with LockOptions
abstract void	refresh(Object object, LockOptions lockOptions) Re-read the state of the given instance from the underlying database, with the given `LockMode`.
abstract void	refresh(Object object) Re-read the state of the given instance from the underlying database.
abstract void	replicate(String entityName, Object object, ReplicationMode replicationMode) Persist the state of the given detached instance, reusing the current identifier value.
abstract void	replicate(Object object, ReplicationMode replicationMode) Persist the state of the given detached instance, reusing the current identifier value.
abstract Serializable	save(String entityName, Object object) Persist the given transient instance, first assigning a generated identifier.
abstract Serializable	save(Object object) Persist the given transient instance, first assigning a generated identifier.
abstract void	saveOrUpdate(Object object) Either `save(Object)` or `update(Object)` the given instance, depending upon resolution of the unsaved-value checks (see the manual for discussion of unsaved-value checking).
abstract void	saveOrUpdate(String entityName, Object object) Either `save(String, Object)` or `update(String, Object)` the given instance, depending upon resolution of the unsaved-value checks (see the manual for discussion of unsaved-value checking).
abstract void	setCacheMode(CacheMode cacheMode) Set the cache mode.
abstract void	setDefaultReadOnly(boolean readOnly) Change the default for entities and proxies loaded into this session from modifiable to read-only mode, or from modifiable to read-only mode.
abstract void	setFlushMode(FlushMode flushMode) Set the flush mode for this session.
abstract void	setReadOnly(Object entityOrProxy, boolean readOnly) Set an unmodified persistent object to read-only mode, or a read-only object to modifiable mode.
abstract void	update(Object object) Update the persistent instance with the identifier of the given detached instance.
abstract void	update(String entityName, Object object) Update the persistent instance with the identifier of the given detached instance.

Public Methods

public abstract Query createSQLQuery (String sql, String returnAlias, Class returnClass)

This method is deprecated.
use addRoot(String, Class) or addEntity(Class) variants instead to define the alias/class

Create a new instance of Query for the given SQL string.

Returned instances should all be SQLQuery.

Parameters

sql	a query expressed in SQL
returnAlias	a table alias that appears inside `{}` in the SQL string
returnClass	the returned persistent class

public abstract Query createSQLQuery (String sql, String[] returnAliases, Class[] returnClasses)

This method is deprecated.
use addRoot(String, Class) or addEntity(Class) variants instead to define the aliases/classes

Create a new instance of Query for the given SQL string.

Returned instances should all be SQLQuery.

Parameters

sql	a query expressed in SQL
returnAliases	an array of table aliases that appear inside `{}` in the SQL string
returnClasses	the returned persistent classes

public abstract int delete (String query)

This method is deprecated.
consider using HQL delete statements

Delete all objects returned by the query. Return the number of objects deleted.

Note that this is very different from the delete-statement support added in HQL since 3.1. The functionality here is to actually peform the query and then iterate the results calling delete(Object) individually.

Parameters

query	the query string

Returns

the number of instances deleted

Throws

HibernateException

public abstract int delete (String query, Object[] values, Type[] types)

This method is deprecated.
consider using HQL delete statements

Delete all objects returned by the query. Return the number of objects deleted.

Note that this is very different from the delete-statement support added in HQL since 3.1. The functionality here is to actually peform the query and then iterate the results calling delete(Object) individually.

Parameters

query	the query string
values	a list of values to be written to "?" placeholders in the query.
types	a list of Hibernate types of the values

Returns

the number of instances deleted

Throws

HibernateException

public abstract int delete (String query, Object value, Type type)

This method is deprecated.
consider using HQL delete statements

Delete all objects returned by the query. Return the number of objects deleted.

Note that this is very different from the delete-statement support added in HQL since 3.1. The functionality here is to actually peform the query and then iterate the results calling delete(Object) individually.

Parameters

query	the query string
value	a value to be witten to a "?" placeholder in the query string.
type	the hibernate type of value.

Returns

the number of instances deleted

Throws

HibernateException

public abstract Collection filter (Object collection, String filter, Object value, Type type)

This method is deprecated.
use createFilter(Object, String).setXYZ.list()

Apply a filter to a persistent collection. A filter is a Hibernate query that may refer to this, the collection element.

Parameters

collection	a persistent collection to filter
filter	a filter query string
value	a value to be witten to a "?" placeholder in the query string
type	the hibernate type of value

Returns

Collection

Throws

HibernateException

public abstract Collection filter (Object collection, String filter, Object[] values, Type[] types)

This method is deprecated.
use createFilter(Object, String).setXYZ.list()

Apply a filter to a persistent collection. Bind the given parameters to "?" placeholders. A filter is a Hibernate query that may refer to this, the collection element.

Parameters

collection	a persistent collection to filter
filter	a filter query string
values	a list of values to be written to "?" placeholders in the query
types	a list of Hibernate types of the values

Returns

Collection

Throws

HibernateException

public abstract Collection filter (Object collection, String filter)

This method is deprecated.
use createFilter(Object, String).list()

Apply a filter to a persistent collection. A filter is a Hibernate query that may refer to this, the collection element. Filters allow efficient access to very large lazy collections. (Executing the filter does not initialize the collection.)

Parameters

collection	a persistent collection to filter
filter	a filter query string

Returns

Collection the resulting collection

Throws

HibernateException

public abstract List find (String query, Object value, Type type)

This method is deprecated.
use createQuery(String).setXYZ.list()

Execute a query with bind parameters, binding a value to a "?" parameter in the query string.

Parameters

query	the query string
value	a value to be bound to a "?" placeholder (JDBC IN parameter).
type	the Hibernate type of the value

Returns

a distinct list of instances (or arrays of instances)

Throws

HibernateException

public abstract List find (String query)

This method is deprecated.
use createQuery(String).list()

Execute a query.

Parameters

query	a query expressed in Hibernate's query language

Returns

a distinct list of instances (or arrays of instances)

Throws

HibernateException

public abstract List find (String query, Object[] values, Type[] types)

This method is deprecated.
use createQuery(String).setXYZ.list()

Execute a query with bind parameters, binding an array of values to "?" parameters in the query string.

Parameters

query	the query string
values	an array of values to be bound to the "?" placeholders (JDBC IN parameters).
types	an array of Hibernate types of the values

Returns

a distinct list of instances

Throws

HibernateException

public abstract Iterator iterate (String query, Object[] values, Type[] types)

This method is deprecated.
use createQuery(String).setXYZ.iterate()

Execute a query and return the results in an iterator. Write the given values to "?" in the query string. If the query has multiple return values, values will be returned in an array of type Object[].

Entities returned as results are initialized on demand. The first SQL query returns identifiers only. So iterate() is usually a less efficient way to retrieve objects than find().

Parameters

query	the query string
values	a list of values to be written to "?" placeholders in the query
types	a list of Hibernate types of the values

Returns

an iterator

Throws

HibernateException

public abstract Iterator iterate (String query)

This method is deprecated.
use createQuery(String).iterate()

Execute a query and return the results in an iterator. If the query has multiple return values, values will be returned in an array of type Object[].

Entities returned as results are initialized on demand. The first SQL query returns identifiers only. So iterate() is usually a less efficient way to retrieve objects than find().

Parameters

query	the query string

Returns

an iterator

Throws

HibernateException

public abstract Iterator iterate (String query, Object value, Type type)

This method is deprecated.
use createQuery(String).setXYZ.iterate()

Execute a query and return the results in an iterator. Write the given value to "?" in the query string. If the query has multiple return values, values will be returned in an array of type Object[].

Entities returned as results are initialized on demand. The first SQL query returns identifiers only. So iterate() is usually a less efficient way to retrieve objects than find().

Parameters

query	the query string
value	a value to be witten to a "?" placeholder in the query string
type	the hibernate type of value

Returns

an iterator

Throws

HibernateException

public abstract void save (Object object, Serializable id)

This method is deprecated.
declare identifier properties for all classes

Persist the given transient instance, using the given identifier. This operation cascades to associated instances if the association is mapped with cascade="save-update".

Parameters

object	a transient instance of a persistent class
id	an unused valid identifier

Throws

HibernateException

public abstract void save (String entityName, Object object, Serializable id)

This method is deprecated.
declare identifier properties for all classes

Persist the given transient instance, using the given identifier. This operation cascades to associated instances if the association is mapped with cascade="save-update".

Parameters

object	a transient instance of a persistent class
id	an unused valid identifier

Throws

HibernateException

public abstract Object saveOrUpdateCopy (String entityName, Object object, Serializable id)

This method is deprecated.
with no replacement

Copy the state of the given object onto the persistent object with the given identifier. If there is no persistent instance currently associated with the session, it will be loaded. Return the persistent instance. If there is no database row with the given identifier, save the given instance and return it as a newly persistent instance. Otherwise, the given instance does not become associated with the session.

Parameters

object	a persistent or transient instance with state to be copied
id	the identifier of the instance to copy to

Returns

an updated persistent instance

Throws

HibernateException

public abstract Object saveOrUpdateCopy (Object object, Serializable id)

This method is deprecated.
with no replacement

Copy the state of the given object onto the persistent object with the given identifier. If there is no persistent instance currently associated with the session, it will be loaded. Return the persistent instance. If there is no database row with the given identifier, save the given instance and return it as a newly persistent instance. Otherwise, the given instance does not become associated with the session.

Parameters

object	a persistent or transient instance with state to be copied
id	the identifier of the instance to copy to

Returns

an updated persistent instance

Throws

HibernateException

public abstract Object saveOrUpdateCopy (Object object)

This method is deprecated.
use merge(Object)

Copy the state of the given object onto the persistent object with the same identifier. If there is no persistent instance currently associated with the session, it will be loaded. Return the persistent instance. If the given instance is unsaved or does not exist in the database, save it and return it as a newly persistent instance. Otherwise, the given instance does not become associated with the session.

Parameters

object	a transient instance with state to be copied

Returns

an updated persistent instance

Throws

HibernateException

public abstract Object saveOrUpdateCopy (String entityName, Object object)

This method is deprecated.
use merge(String, Object)

Copy the state of the given object onto the persistent object with the same identifier. If there is no persistent instance currently associated with the session, it will be loaded. Return the persistent instance. If the given instance is unsaved or does not exist in the database, save it and return it as a newly persistent instance. Otherwise, the given instance does not become associated with the session.

Parameters

object	a transient instance with state to be copied

Returns

an updated persistent instance

Throws

HibernateException

public abstract void update (Object object, Serializable id)

This method is deprecated.
declare identifier properties for all classes

Update the persistent state associated with the given identifier. An exception is thrown if there is a persistent instance with the same identifier in the current session. This operation cascades to associated instances if the association is mapped with cascade="save-update".

Parameters

object	a detached instance containing updated state
id	identifier of persistent instance

Throws

HibernateException

public abstract void update (String entityName, Object object, Serializable id)

This method is deprecated.
declare identifier properties for all classes

Update the persistent state associated with the given identifier. An exception is thrown if there is a persistent instance with the same identifier in the current session. This operation cascades to associated instances if the association is mapped with cascade="save-update".

Parameters

object	a detached instance containing updated state
id	identifier of persistent instance

Throws

HibernateException

Interfaces

Exceptions

Session

Class Overview

Summary

Public Methods

public abstract Query createSQLQuery (String sql, String returnAlias, Class returnClass)

Parameters

public abstract Query createSQLQuery (String sql, String[] returnAliases, Class[] returnClasses)

Parameters

public abstract int delete (String query)

Parameters

Returns

Throws

public abstract int delete (String query, Object[] values, Type[] types)

Parameters

Returns

Throws

public abstract int delete (String query, Object value, Type type)

Parameters

Returns

Throws

public abstract Collection filter (Object collection, String filter, Object value, Type type)

Parameters

Returns

Throws

public abstract Collection filter (Object collection, String filter, Object[] values, Type[] types)

Parameters

Returns

Throws

public abstract Collection filter (Object collection, String filter)

Parameters

Returns

Throws

public abstract List find (String query, Object value, Type type)

Parameters

Returns

Throws

See Also

public abstract List find (String query)

Parameters

Returns

Throws

public abstract List find (String query, Object[] values, Type[] types)

Parameters

Returns

Throws

See Also

public abstract Iterator iterate (String query, Object[] values, Type[] types)

Parameters

Returns

Throws

public abstract Iterator iterate (String query)

Parameters

Returns

Throws

public abstract Iterator iterate (String query, Object value, Type type)

Parameters

Returns

Throws

public abstract void save (Object object, Serializable id)

Parameters

Throws

public abstract void save (String entityName, Object object, Serializable id)

Parameters

Throws

public abstract Object saveOrUpdateCopy (String entityName, Object object, Serializable id)

Parameters

Returns

Throws

public abstract Object saveOrUpdateCopy (Object object, Serializable id)

Parameters

Returns

Throws

public abstract Object saveOrUpdateCopy (Object object)

Parameters

Returns

Throws

public abstract Object saveOrUpdateCopy (String entityName, Object object)

Parameters