/*************************************************************************
 *
 *  $RCSfile: XContentProvider.idl,v $
 *
 *  $Revision: 1.8 $
 *
 *  last change: $Author: abi $ $Date: 2002/11/05 10:18:12 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser 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
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_ucb_XContentProvider_idl__
#define __com_sun_star_ucb_XContentProvider_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_ucb_XContentIdentifier_idl__
#include <com/sun/star/ucb/XContentIdentifier.idl>
#endif

#ifndef __com_sun_star_ucb_XContent_idl__
#include <com/sun/star/ucb/XContent.idl>
#endif

#ifndef __com_sun_star_ucb_IllegalIdentifierException_idl__
#include <com/sun/star/ucb/IllegalIdentifierException.idl>
#endif

//=============================================================================

module com { module sun { module star { module ucb {

//=============================================================================
/** a content provider which creates and manages <type>XContent</type>s.

     @version  1.0
     @author   Kai Sommerfeld
     @see      XContent
	 @see	   XContentIdentifier
*/
interface XContentProvider: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
	/** creates a new <type>XContent</type> instance, if the given
	    <type>XContentIdentifier</type> matches a content provided by the
		implementation of this interface.

		@param Identifier
		an identifier for the content to query.

		@returns
		the content.

		@throws IllegalIdentifierException
		if the given identifier does not match a content provided by the
		implementation of this interface
	*/
	com::sun::star::ucb::XContent queryContent(
				[in] com::sun::star::ucb::XContentIdentifier Identifier )
		raises ( com::sun::star::ucb::IllegalIdentifierException );

	//-------------------------------------------------------------------------
	/** compares two <type>XContentIdentifier</type>s.

		@param Id1
		first content identifier.

		@param Id2
		second content identifier.

		@returns
		<code>0</code> is returned, if the identifiers are equal.
		A value	less than <code>0</code> indiactes, that the Id1
		is less than Id2. A value greater than <code>0</code>
		is returned, if Id1 is greater than Id2.
	*/
	long compareContentIds(
				[in] com::sun::star::ucb::XContentIdentifier Id1,
			 	[in] com::sun::star::ucb::XContentIdentifier Id2 );
};

//=============================================================================

}; }; }; };

#endif
