xref: /aoo41x/main/offapi/com/sun/star/ucb/RemoteProxyContentProvider.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_ucb_RemoteProxyContentProvider_idl__
#define __com_sun_star_ucb_RemoteProxyContentProvider_idl__

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

 published interface XContentIdentifierFactory;
 published interface XContentProvider;
 published interface XParameterizedContentProvider;

//============================================================================
/** A <type>ContentProvider</type> that wraps remote content providers that
    (potentially) have been distributed to a UCB.

    <p>Before trying to pass a request to a 'real,' underlying content provider
    (which will most likely be a remote content provider distributed to this
    UCB), this proxy first activates any remote content providers that have
    been distributed here, but are still inactive (see
    <type>RemoteContentProviderAcceptor</type> and
    <type>XRemoteContentProviderActivator</type> for more information).

    <p>The way this works might change, therefore this interface is marked as
    deprectated.

    @deprecated
 */
published service RemoteProxyContentProvider
{
    //------------------------------------------------------------------------
    /** activates any potentially inactive remote content providers before
        passing on requests to the underlying <type>XContentProvider</type>.
     */
    interface XContentProvider;

    //------------------------------------------------------------------------
    /** activates any potentially inactive remote content providers before
        passing on requests to the underlying
        <type>XContentIdentifierFactory</type>.
     */
    [optional] interface XContentIdentifierFactory;

    //------------------------------------------------------------------------
	/** allows this <type>ContentProvider</type> to adjust itself to special
		needs.
     */
    [optional] interface XParameterizedContentProvider;
};

}; }; }; };

#endif