beagled/IBackend.cs

   1 //
   2 // IBackend.cs
   3 //
   4 // Copyright (C) 2004-2006 Novell, Inc.
   5 //
   6
   7 //
   8 // Permission is hereby granted, free of charge, to any person obtaining a
   9 // copy of this software and associated documentation files (the "Software"),
  10 // to deal in the Software without restriction, including without limitation
  11 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
  12 // and/or sell copies of the Software, and to permit persons to whom the
  13 // Software is furnished to do so, subject to the following conditions:
  14 //
  15 // The above copyright notice and this permission notice shall be included in
  16 // all copies or substantial portions of the Software.
  17 //
  18 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  23 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  24 // DEALINGS IN THE SOFTWARE.
  25 //
  26
  27 using System;
  28
  29 using Beagle.Util;
  30
  31 namespace Beagle.Daemon {
  32
  33         public interface IBackend {
  34
  35                 void Start ();
  36
  37                 string Name { get; set; }
  38
  39                 QueryDomain Domain { get; set; }
  40
  41                 IQueryable Queryable { get; }
  42
  43                 string GetSnippet (string[] query_terms, Hit hit);
  44
  45                 // XXX: Need to fix QueryableStatus name
  46                 QueryableStatus GetBackendStatus ();
  47         }
  48
  49         [AttributeUsage (AttributeTargets.Assembly)]
  50         public class IBackendTypesAttribute : TypeCacheAttribute {
  51                 public IBackendTypesAttribute (params Type[] backend_types) : base (backend_types) { }
  52         }
  53 }