FrameControl - Framework for creating web applications

using System;
using System.Collections;

namespace JobMorning
{
	/// <summary>
	/// ActionClass is a class which is instantiated when the attribute actionClass of a page
	/// element is set to the name of a class. ActionClass makes the interactions between user's
	/// object and FrameControl easy.
	/// </summary>
	public abstract class ActionClass
	{
		public ActionClass()
		{
			//
			// TODO: Add constructor logic here
			//
		}
		/// <summary>
		/// Procedure called before the page mentionned in the XML file is loaded and displayed.
		/// </summary>
		/// <param name="strXmContext">The MCContext document is passed as a string containing its XML definition</param>
		protected abstract void DoBeforeDisplay(string strXmlMCContext);
		
		
		/// <summary>
		/// doPageValidation validates the page input. 
		/// If the result is false, the page is displayed again with a PopUp message containing
		/// strErrorMessage. 
		/// </summary>
		/// <param name="pageInputs">Hashtable containing all input fields of the page, indexed 
		/// by their id.</param>
		/// <param name="strErrorMessage">The error message to display in the PopUp.</param>
		/// <returns></returns>
		protected abstract bool ValidatePageBeforeSavePoints(Hashtable pageInputs,out string strErrorMessage);
		

		/// <summary>
		/// ValidatePageAfterSavePoint validates the page input after a savePoint has been executed.
		/// The savePoint must be contained in the current path between the current page and its successor.
		/// </summary>
		/// <param name="strSavePointName">The SavePoint name from where the validation will be launched.</param>
		/// <param name="pageInputs">Hashtable containing all input fields of the page, indexed 
		/// by their id.</param>
		/// <param name="strErrorMessage">The error message to display in the PopUp.</param>
		protected abstract bool ValidatePageAfterSavePoint(string strSavePointName,  string strXmlMCContext, out string strErrorMessage);
		

		/// <summary>
		/// Procedure called after the page has been posted and that all values have been saved
		/// into the context. This procedure is executed after ValidatePageBeforeSavePoints.
		/// </summary>
		/// <param name="strXmlSession">The string representing an Xml Session</param>
		protected abstract void DoAfterContextSave(string strXmlMCContext);

	}
}