File : adagio-searches-handler.ads


------------------------------------------------------------------------------

--                         ADAGIO - ADALID - AENEA.                         --

--                                                                          --

--                            Copyright (C) 2003                            --

--                                 A. Mosteo.                               --

--                                                                          --

--  Authors: A. Mosteo. (adagio@mosteo.com)                                 --

--                                                                          --

--  If you have any questions in regard to this software, please address    --

--  them to the above email.                                                --

--                                                                          --

--  This program is free software; you can redistribute it and/or modify    --

--  it under the terms of the GNU General Public License as published by    --

--  the Free Software Foundation; either version 2 of the License, or (at   --

--  your option) any later version.                                         --

--                                                                          --

--  This program 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       --

--  General Public License for more details.                                --

--                                                                          --

--  You should have received a copy of the GNU General Public License       --

--  along with this library; if not, write to the Free Software Foundation, --

--  Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.          --

--                                                                          --

--  You are not allowed to use any part of this code to develop a program   --

--  whose output would be used to harass or prosecute other users of the    --

--  networks Adagio connects with. All data collected with Adagio or a tool --

--  containing Adagio code about other network users must remain            --

--  confidential and cannot be made public by any mean, nor be used to      --

--  harass or legally prosecute these users.                                --

------------------------------------------------------------------------------

--  $Id: adagio-upload.ads,v 1.4 2004/01/21 21:05:51 Jano Exp $


package Adagio.Searches.Handler is

   ------------------------------------------------------------------------

   -- Object                                                             --

   ------------------------------------------------------------------------

   -- This is the abstract object that any network must extend to provide 

   -- search functionality.

   type Object is abstract tagged limited private;
   type Object_Access is access all Object'Class;

   ------------------------------------------------------------------------

   -- Create_Search                                                      --

   ------------------------------------------------------------------------

   -- Notify the creation of a new search                                

   procedure Create_Search (
      This : access Object; Target : in Search_Id) is abstract;

   ------------------------------------------------------------------------

   -- Delete_Search                                                      --

   ------------------------------------------------------------------------

   procedure Delete_Search (
      This : access Object; Target : in Search_Id) is abstract;

   ------------------------------------------------------------------------

   -- Get_Custom_Info                                                    --

   ------------------------------------------------------------------------

   -- Intended to allow each network to provide some progress info.

   function Get_Custom_Info (This : access Object; Target : in Search_Id) return String
      is abstract;

   ------------------------------------------------------------------------

   -- Set_Paused                                                         --

   ------------------------------------------------------------------------

   procedure Set_Paused (
      This   : access Object; 
      Target : in     Search_Id; 
      Paused : in     Boolean := true) is abstract;

   ------------------------------------------------------------------------

   -- Set_Priority                                                       --

   ------------------------------------------------------------------------

   procedure Set_Priority (
      This : access Object; Target : in Search_Id; Priority : in Priorities) is abstract;

private

   type Object is abstract tagged limited null record;
   
end Adagio.Searches.Handler;