using System;
using System.Collections.Generic;
using System.Linq;


namespace EPS.Common.Repositories
{
	/// <summary>
	/// This is the contact for a repository.
	/// </summary>
	/// <typeparam name="TModel">This is the type that will be used in the repository, it must
	/// implement IModel and have a public parameterless constructor.</typeparam>
	public interface IRepository<TModel>
				where TModel : IModel, new()
	{
		
		/// <summary>
		/// Finds an instance of TModel by id.
		/// </summary>
		/// <param name="id">The id of the TModel instance to find.</param>
		/// <returns>TModel if the id is found, otherwise null.</returns>
		TModel Find(int id);

		/// <summary>
		/// Doesn't really find anything, just returns everything in the repository.
		/// </summary>
		/// <returns>The contents of the repository.</returns>
		IEnumerable<TModel> FindAll();


		/// <summary>
		/// Orders the list by property name.
		/// </summary>
		/// <param name="propertyName">Name of the property.</param>
		/// <param name="sortDirection">The sort direction.</param>
		/// <returns>A new list sorted by property name in the order indicated by the sortDirection.</returns>
		IEnumerable<TModel> OrderBy(string propertyName, Sort sortDirection);

		/// <summary>
		/// Orders the list by property name.
		/// </summary>
		/// <param name="values">Values to indicate sorting properties. 
		/// eg, new { Property = "FirName", SortAscending = true }</param>
		/// <returns></returns>
		IEnumerable<TModel> OrderBy(object values);

        /// <summary>
		/// Inserts the instance if it does not already exist, otherwise updates the existing one.
		/// </summary>
		/// <param name="model">The model to save.</param>
		void Save(TModel model);

		/// <summary>
		/// Deletes the specified model from the repository.
		/// </summary>
		/// <param name="model">The model to be removed.</param>
		void Delete(TModel model);

		/// <summary>
		/// Gets a count of the number of models in the repository.
		/// </summary>
		/// <value>The number of models in the repository.</value>
		int Count { get; }
	}
}