offapi/com/sun/star/ucb/RemoteAccessContentProvider.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: RemoteAccessContentProvider.idl,v $
  10  * $Revision: 1.11 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_ucb_RemoteAccessContentProvider_idl__
  31 #define __com_sun_star_ucb_RemoteAccessContentProvider_idl__
  32
  33 #ifndef __com_sun_star_ucb_ContentProvider_idl__
  34 #include <com/sun/star/ucb/ContentProvider.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_ucb_XParameterizedContentProvider_idl__
  38 #include <com/sun/star/ucb/XParameterizedContentProvider.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com { module sun { module star { module ucb {
  44
  45 //=============================================================================
  46 /** A <type>RemoteAccessContentProvider</type> is a
  47     <type>ContentProvider</type> that provides access to contents available at
  48     other (remote) UCBs.
  49 */
  50 published service RemoteAccessContentProvider
  51 {
  52     //-------------------------------------------------------------------------
  53     /** A <type>RemoteAccessContentProvider</type> is a specialized
  54         <type>ContentProvider</type>.
  55      */
  56     service com::sun::star::ucb::ContentProvider;
  57
  58     //-------------------------------------------------------------------------
  59     /** allows configuration of the <type>RemoteAccessContentProvider</type>,
  60         to specify that certain <type>XContentIdentifier</type>s map to
  61         <type>XContent</type>s from a certain remote UCB.  The Arguments
  62         string in the
  63         <member>XParameterizedContentProvider::registerInstance</member>
  64         call must contain the UNO URL of the remote UCB.
  65
  66         @descr
  67         The <type>XContentProvider</type>s obtained through this interface
  68         implement the service <type>ContentProvider</type> and, if
  69         appropriate, also the interface <type>XFileIdentifierConverter</type>.
  70      */
  71     interface com::sun::star::ucb::XParameterizedContentProvider;
  72 };
  73
  74 //=============================================================================
  75
  76 }; }; }; };
  77
  78 #endif