WinForms controls to develop with the Pfz.Databasing framework

using System;

namespace Pfz.Databasing
{
	/// <summary>
	/// Base class used in auto-implemented records.
	/// You can also create classes derived from it if you need to create a
	/// non-persisted record.
	/// </summary>
	[Serializable]
	public class RecordBase:
		IRecord
	{
		/// <summary>
		/// Gets an empty RecordBase instance.
		/// This is used in the ThreadErrors when there is no record.
		/// </summary>
		public static readonly IRecord Empty = new RecordBase();
	
		private bool fMustDeleteOnApply;
		
		/// <summary>
		/// The constructor is internal so the class must be inherited.
		/// </summary>
		internal protected RecordBase()
		{
		}
		
		/// <summary>
		/// Gets a value determining if this record must be
		/// deleted if it is applied.
		/// </summary>
		public bool GetMustDeleteOnApply()
		{
			return fMustDeleteOnApply;
		}
		/// <summary>
		/// Sets the MustDeleteOnApply field without doing any checking.
		/// </summary>
		internal protected void SetMustDeleteOnApply(bool value)
		{
			fMustDeleteOnApply = value;
		}
		
		/// <summary>
		/// Marks the actual record for deletion.
		/// </summary>
		public void Delete()
		{
			if (fRecordMode != RecordMode.ReadOnly)
				throw new DatabaseException("Only read-only (loaded) records can be marked for deletion.");
				
			fMustDeleteOnApply = true;
		}
		
		/// <summary>
		/// Unmarks the actual record for deletion.
		/// </summary>
		public void CancelDelete()
		{
			fMustDeleteOnApply = false;
		}
	
		private RecordMode fRecordMode;
		
		/// <summary>
		/// Gets the recordMode of this record.
		/// </summary>
		/// <returns></returns>
		public RecordMode GetRecordMode()
		{
			return fRecordMode;
		}
		/// <summary>
		/// Sets the record-mode without any checking.
		/// </summary>
		internal protected void SetRecordMode(RecordMode value)
		{
			fRecordMode = value;
		}

		private IRecord fOldRecord;
		
		/// <summary>
		/// Gets the OldRecord, if one exists (only for update).
		/// </summary>
		public IRecord GetUntypedOldRecord()
		{
			return fOldRecord;
		}
		/// <summary>
		/// Sets the OldRecord without any checking.
		/// </summary>
		internal protected void SetUntypedOldRecord(IRecord value)
		{
			fOldRecord = value;
		}

		/// <summary>
		/// Throws a NotImplementedException.
		/// If you need it, override it and don't call base.
		/// </summary>
		public virtual IRecord UntypedCreateUpdateRecord()
		{
			throw new NotImplementedException();
		}

		/// <summary>
		/// Throws a NotImplementedException.
		/// If you need it, override it and don't call base.
		/// </summary>
		public virtual object Clone()
		{
			throw new NotImplementedException();
		}
	}
}