/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */
#ifndef __com_sun_star_ucb_XContentProvider_idl__
#define __com_sun_star_ucb_XContentProvider_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/ucb/XContentIdentifier.idl>
#include <com/sun/star/ucb/XContent.idl>
#include <com/sun/star/ucb/IllegalIdentifierException.idl>


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

/** a content provider which creates and manages XContents.

     @version  1.0
     @author   Kai Sommerfeld
     @see      XContent
     @see      XContentIdentifier
*/
published interface XContentProvider: com::sun::star::uno::XInterface
{
    /** creates a new XContent instance, if the given
        XContentIdentifier 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 XContentIdentifiers.

        @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> indicates, 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

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
