AOO410/main/offapi/com/sun/star/ucb/XContentProvider.idl

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/


#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
*/
published 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