MonoRail/Castle.MonoRail.Framework/Services/AjaxProxyGenerator/IAjaxProxyGenerator.cs

   1 // Copyright 2004-2007 Castle Project - http://www.castleproject.org/
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 namespace Castle.MonoRail.Framework.Services.AjaxProxyGenerator
  16 {
  17         using System;
  18
  19         /// <summary>
  20         /// Provides a service which generates a <em>JavaScript</em> block, that
  21         /// can be used to call Ajax actions on the controller.
  22         /// </summary>
  23         public interface IAjaxProxyGenerator
  24         {
  25                 /// <summary>
  26                 /// Generates an AJAX JavaScript proxy for a given controller.
  27                 /// </summary>
  28                 /// <param name="context">The context of the current request</param>
  29                 /// <param name="proxyName">Name of the javascript proxy object</param>
  30                 /// <param name="controller">Controller which will be target of the proxy</param>
  31                 /// <param name="area">area which the controller belongs to</param>
  32                 String GenerateJSProxy(IRailsEngineContext context, String proxyName, String area, String controller);
  33         }
  34 }