ControllerBase.cs :  » Web-Frameworks » Ingenious-MVC » Ingenious » Mvc » Controllers » C# / CSharp Open Source

#region License

/**
 * Ingenious MVC : An MVC framework for .NET 2.0
 * Copyright (C) 2006, JDP Group
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 * 
 * Authors: - Kent Boogaart (kentcb@internode.on.net)
 */

#endregion

using System;
using Ingenious.Mvc.Util;

namespace Ingenious.Mvc.Controllers{
  /// <include file='ControllerBase.doc.xml' path='/doc/member[@name="T:ControllerBase"]/*'/>
  [Serializable]
  public abstract class ControllerBase : IController
  {
    private readonly Id<IController> _id;
    private readonly Task _task;
    private readonly INavigator _navigator;

    /// <include file='ControllerBase.doc.xml' path='/doc/member[@name="P:Id"]/*'/>
    public Id<IController> Id
    {
      get
      {
        return _id;
      }
    }

    /// <include file='ControllerBase.doc.xml' path='/doc/member[@name="P:Task"]/*'/>
    protected Task Task
    {
      get
      {
        return _task;
      }
    }

    /// <include file='ControllerBase.doc.xml' path='/doc/member[@name="P:Navigator"]/*'/>
    protected INavigator Navigator
    {
      get
      {
        return _navigator;
      }
    }

    /// <include file='ControllerBase.doc.xml' path='/doc/member[@name="M:.ctor(Ingenious.Mvc.Id`1,Ingenious.Mvc.Task,Ingenious.Mvc.INavigator)"]/*'/>
    protected ControllerBase(Id<IController> id, Task task, INavigator navigator)
    {
      ArgumentHelper.AssertNotEmpty(id, "id");
      ArgumentHelper.AssertNotNull(task, "task");
      ArgumentHelper.AssertNotNull(navigator, "navigator");
      _id = id;
      _task = task;
      _navigator = navigator;
    }

    /// <include file='ControllerBase.doc.xml' path='/doc/member[@name="M:Initialize()"]/*'/>
    public virtual void Initialize()
    {
    }
  }
}