libbeagle/beagle/beagle-hit.h

   1 /*
   2  * beagle-hit.h
   3  *
   4  * Copyright (C) 2005 Novell, Inc.
   5  *
   6  */
   7
   8 /*
   9  * Permission is hereby granted, free of charge, to any person obtaining a
  10  * copy of this software and associated documentation files (the "Software"),
  11  * to deal in the Software without restriction, including without limitation
  12  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  13  * and/or sell copies of the Software, and to permit persons to whom the
  14  * Software is furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included in
  17  * all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  24  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  25  * DEALINGS IN THE SOFTWARE.
  26  */
  27
  28 #ifndef __BEAGLE_HIT_H
  29 #define __BEAGLE_HIT_H
  30
  31 #include <glib.h>
  32 #include <beagle/beagle-property.h>
  33 #include <beagle/beagle-timestamp.h>
  34
  35 #define BEAGLE_HIT(x) ((BeagleHit *) x)
  36
  37 typedef struct _BeagleHit BeagleHit;
  38
  39 BeagleHit * beagle_hit_ref (BeagleHit *hit);
  40 void beagle_hit_unref (BeagleHit *hit);
  41
  42 G_CONST_RETURN char *beagle_hit_get_uri (BeagleHit *hit);
  43 G_CONST_RETURN char *beagle_hit_get_type (BeagleHit *hit);
  44 G_CONST_RETURN char *beagle_hit_get_mime_type (BeagleHit *hit);
  45 G_CONST_RETURN char *beagle_hit_get_source (BeagleHit *hit);
  46 G_CONST_RETURN char *beagle_hit_get_parent_uri (BeagleHit *hit);
  47
  48 BeagleTimestamp *beagle_hit_get_timestamp (BeagleHit *hit);
  49
  50 double beagle_hit_get_score (BeagleHit *hit);
  51
  52 gboolean  beagle_hit_get_one_property   (BeagleHit   *hit,
  53                                          const char  *key,
  54                                          const char **value);
  55 GSList   *beagle_hit_get_properties     (BeagleHit   *hit,
  56                                          const char  *key);
  57 GSList   *beagle_hit_get_all_properties (BeagleHit   *hit);
  58
  59 #endif /* __BEAGLE_HIT_H */
  60