Zip My Code

using System;

namespace ZipMyCode.Service.Tasks
{
	/// <summary>
	/// Abstract base class for all tasks.
	/// </summary>
	abstract class TaskBase : ITask
	{
		#region ITask Members

		/// <summary>
		/// Event sent when the task is finished.
		/// </summary>
		public event EventHandler Finished;


		/// <summary>
		/// Gets the name of the task.
		/// </summary>
		public string Name { get; protected set; }


		/// <summary>
		/// Runs the task.
		/// </summary>
		/// <returns>Status describing the outcome of the task.</returns>
		public TaskStatus Run()
		{
			// Run task
			TaskStatus result = InternalRun();

			// Send finished event
			OnFinished();

			// Return result
			return result;
		}

		#endregion


		/// <summary>
		/// Runs the task.
		/// </summary>
		/// <returns>Status describing the outcome of the task.</returns>
		protected abstract TaskStatus InternalRun();


		/// <summary>
		/// Sends the Finished event to anybody listening.
		/// </summary>
		protected virtual void OnFinished()
		{
			if (Finished != null)
			{
				Finished(this, EventArgs.Empty);
			}
		}
	}
}