/Source/Bifrost/Entities/IEntityContext.cs

#region License

//

// Copyright (c) 2008-2012, DoLittle Studios and Komplett ASA

//

// Licensed under the Microsoft Permissive License (Ms-PL), Version 1.1 (the "License")

// With one exception :

//   Commercial libraries that is based partly or fully on Bifrost and is sold commercially, 

//   must obtain a commercial license.

//

// You may not use this file except in compliance with the License.

// You may obtain a copy of the license at 

//

//   http://bifrost.codeplex.com/license

//

// 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

using System;

using System.Linq;



namespace Bifrost.Entities

{

	/// <summary>

	/// Defines a context for working with entities typically stored in a datastore

	/// </summary>

	/// <typeparam name="T">Type of entity the context works on</typeparam>

	public interface IEntityContext<T> : IDisposable

	{

		/// <summary>

		/// Gets a queryable that one can do queries against

		/// </summary>

		IQueryable<T> Entities { get; }



		/// <summary>

		/// Attach an entity to the context

		/// </summary>

		/// <param name="entity">Entity to attach</param>

		/// <remarks>

		/// In some conditions you might have an untracked entity, in order for that

		/// entity to be state handled by some implementations; you need to attach it.

		/// </remarks>

		void Attach(T entity);



		/// <summary>

		/// Insert a newly created entity

		/// </summary>

		/// <param name="entity">Entity to insert</param>

		void Insert(T entity);



		/// <summary>

		/// Update an existing entity

		/// </summary>

		/// <param name="entity">Entity to update</param>

		void Update(T entity);



		/// <summary>

		/// Delete an existing entity

		/// </summary>

		/// <param name="entity">Entity to delete</param>

		void Delete(T entity);



        /// <summary>

        /// Save en existing entity

        /// </summary>

        /// <param name="entity">Entity to save</param>

	    void Save(T entity);



		/// <summary>

		/// Commit any changes in the context

		/// </summary>

		void Commit();

	}

}