/*
 * beagle-indexable.h
 *
 * Copyright (C) 2005 Novell, Inc.
 *
 */

/*
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

#ifndef __BEAGLE_INDEXABLE_H
#define __BEAGLE_INDEXABLE_H

#include <glib-object.h>
#include <beagle/beagle-property.h>
#include <beagle/beagle-timestamp.h>

typedef struct _BeagleIndexable BeagleIndexable;

typedef enum {
	BEAGLE_INDEXABLE_TYPE_ADD,
	BEAGLE_INDEXABLE_TYPE_REMOVE,
	BEAGLE_INDEXABLE_TYPE_PROPERTY_CHANGE
} BeagleIndexableType;

typedef enum {
	BEAGLE_INDEXABLE_FILTERING_ALWAYS,
	BEAGLE_INDEXABLE_FILTERING_ALREADY_FILTERED,
	BEAGLE_INDEXABLE_FILTERING_AUTOMATIC,
	BEAGLE_INDEXABLE_FILTERING_NEVER
} BeagleIndexableFiltering;

BeagleIndexable *beagle_indexable_new              (const char      *uri);

void             beagle_indexable_free             (BeagleIndexable *indexable);

void             beagle_indexable_add_property     (BeagleIndexable *indexable,
						    BeagleProperty  *prop);

BeagleIndexableType beagle_indexable_get_type   (BeagleIndexable *indexable);
void		 beagle_indexable_set_type	(BeagleIndexable *indexable, 
						 BeagleIndexableType type);

G_CONST_RETURN char *
beagle_indexable_get_uri                           (BeagleIndexable *indexable);
void             beagle_indexable_set_uri          (BeagleIndexable *indexable,
						    const char      *uri);

G_CONST_RETURN char *
beagle_indexable_get_parent_uri			    (BeagleIndexable *indexable);
void             beagle_indexable_set_parent_uri    (BeagleIndexable *indexable,
						    const char      *uri);

G_CONST_RETURN char *
beagle_indexable_get_content_uri                   (BeagleIndexable *indexable);

void             beagle_indexable_set_content_uri  (BeagleIndexable *indexable,
						    const char      *content_uri);

G_CONST_RETURN char *
beagle_indexable_get_hot_content_uri               (BeagleIndexable *indexable);
void           
beagle_indexable_set_hot_content_uri               (BeagleIndexable *indexable,
						    const char      *hot_content_uri);

BeagleTimestamp *beagle_indexable_get_timestamp (BeagleIndexable *indexable);
void             beagle_indexable_set_timestamp (BeagleIndexable *indexable,
						 BeagleTimestamp *timestamp);

gboolean beagle_indexable_get_delete_content       (BeagleIndexable *indexable);
void     beagle_indexable_set_delete_content       (BeagleIndexable *indexable,
						    gboolean         delete_content);

gboolean         beagle_indexable_get_crawled      (BeagleIndexable *indexable);
void             beagle_indexable_set_crawled      (BeagleIndexable *indexable, gboolean crawled);

gboolean         beagle_indexable_get_no_content   (BeagleIndexable *indexable);
void             beagle_indexable_set_no_content   (BeagleIndexable *indexable, 
						    gboolean         no_content);

gboolean         beagle_indexable_get_cache_content(BeagleIndexable *indexable);
void             beagle_indexable_set_cache_content(BeagleIndexable *indexable,
						    gboolean cache_content);

BeagleIndexableFiltering
beagle_indexable_get_filtering                     (BeagleIndexable *indexable);
void             beagle_indexable_set_filtering    (BeagleIndexable *indexable,
						    BeagleIndexableFiltering filtering);

G_CONST_RETURN char *beagle_indexable_get_hit_type  (BeagleIndexable *indexable);
void             beagle_indexable_set_hit_type	    (BeagleIndexable *indexable, 
						    const char      *hit_type);

G_CONST_RETURN char *beagle_indexable_get_mime_type(BeagleIndexable *indexable);
void             beagle_indexable_set_mime_type    (BeagleIndexable *indexable, 
						    const char      *mime_type);

G_CONST_RETURN char *beagle_indexable_get_source    (BeagleIndexable *indexable);
void             beagle_indexable_set_source	    (BeagleIndexable *indexable, 
						    const char      *source);

#endif /* __BEAGLE_INDEXABLE_H */