#region License

/*
 * Copyright © 2002-2005 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#endregion

#region Imports

using System;
using NHibernate;

#endregion

namespace Spring.Data.NHibernate
{
	/// <summary>
    /// Callback interface for NHibernate code.
    /// </summary>
    /// <remarks>To be used with HibernateTemplate execute
    /// method. The typical implementation will call 
    /// Session.load/find/save/update to perform
    /// some operations on persistent objects.
	/// </remarks>
	/// <author>Mark Pollack (.NET)</author>
	public interface IHibernateCallback 
	{
        /// <summary>
        /// Gets called by HibernateTemplate with an active
        /// Hibernate Session. Does not need to care about activating or closing
        /// the Session, or handling transactions.
        /// </summary>
        /// <remarks>
        /// <p>
        /// Allows for returning a result object created within the callback, i.e.
        /// a domain object or a collection of domain objects. Note that there's
        /// special support for single step actions: see HibernateTemplate.find etc.
        /// </p>
        /// </remarks>
        /// <returns>A result object, or null if none.</returns>   
        object DoInHibernate(ISession session);
	}
}
