/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: FileContentProvider.idl,v $
 *
 *  $Revision: 1.4 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 07:27:12 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 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
 *
 ************************************************************************/
#ifndef __com_sun_star_ucb_FileContentProvider_idl__
#define __com_sun_star_ucb_FileContentProvider_idl__

#ifndef __com_sun_star_ucb_XContentProvider_idl__
#include <com/sun/star/ucb/XContentProvider.idl>
#endif
#ifndef __com_sun_star_ucb_XFileIdentifierConverter_idl__
#include <com/sun/star/ucb/XFileIdentifierConverter.idl>
#endif
#ifndef __com_sun_star_ucb_XContentIdentifierFactory_idl__
#include <com/sun/star/ucb/XContentIdentifierFactory.idl>
#endif
#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

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

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

//=============================================================================
/** The File Content Provider (FCP) implements a <type>ContentProvider</type>
    for the <Type>UniversalContentBroker</type> (UCB).

    <p>The served contents enable access to the local file system.

    <p>The FCP is able to restrict access to the local file system to a number
    of directories shown to the client under configurable aliasnames.

    @see com::sun::star::ucb::Content
*/
published service FileContentProvider
{
    //-------------------------------------------------------------------------
    /** provides an object representing either a directory or a file in the
        local file system.

        @see com::sun::star::ucb::FileContent
     */

    interface com::sun::star::ucb::XContentProvider;

    //-------------------------------------------------------------------------
    /** This interface is implemented according to the specification of
        service <type>ContentProvider</type>.
    */

    interface com::sun::star::ucb::XContentIdentifierFactory;

    //-------------------------------------------------------------------------
    /** provides access to properties supported by the UCP.

        <p> The supported properties give two kinds of meta-information about
        the environment of the FCP, namely property <b>HostName</b> containing
        the name of the computer, and property <b>FileSystemNotation</b>
        determining which system dependent notation the file system identifier
        follow.

           <p>

           <b>Supported Properties</b>
           <ul>
           <li>
           string HostName ( read-only )
           </li>
           <li>
           long FileSystemNotation ( read-only, the value is one of the
        <type>FileSystemNotation</type> constants )
           </li>
           </ul>

           </p>
    */

    interface com::sun::star::beans::XPropertySet;

    //-------------------------------------------------------------------------
    /** specifies methods to convert between (file) URLs and file paths in
        system dependent notation
    */

    interface com::sun::star::ucb::XFileIdentifierConverter;
};

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

}; }; }; };

#endif
