initial import

1 files changed, 760 insertions, 0 deletions

diff --git a/ucbhelper/inc/ucbhelper/content.hxx b/ucbhelper/inc/ucbhelper/content.hxx
new file mode 100644
index 000000000000..6c2c4092af17
--- /dev/null
+++ b/ucbhelper/inc/ucbhelper/content.hxx
@@ -0,0 +1,760 @@
+/*************************************************************************
+ *
+ *  $RCSfile: content.hxx,v $
+ *
+ *  $Revision: 1.1.1.1 $
+ *
+ *  last change: $Author: hr $ $Date: 2000-09-18 17:03:36 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 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
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#ifndef _UCBHELPER_CONTENT_HXX
+#define _UCBHELPER_CONTENT_HXX
+
+#ifndef _COM_SUN_STAR_UNO_REFERENCE_HXX_
+#include <com/sun/star/uno/Reference.hxx>
+#endif
+#ifndef _COM_SUN_STAR_UNO_SEQUENCE_HXX_
+#include <com/sun/star/uno/Sequence.hxx>
+#endif
+#ifndef _VOS_REF_HXX_
+#include <vos/ref.hxx>
+#endif
+
+namespace com { namespace sun { namespace star { namespace beans {
+    class XPropertySetInfo;
+} } } }
+
+namespace com { namespace sun { namespace star { namespace io {
+    class XActiveDataSink;
+    class XOutputStream;
+    class XInputStream;
+} } } }
+
+namespace com { namespace sun { namespace star { namespace sdbc {
+    class XResultSet;
+    class XRow;
+} } } }
+
+namespace com { namespace sun { namespace star { namespace ucb {
+    class CommandAbortedException;
+    class XCommandEnvironment;
+    class XCommandInfo;
+    class XContent;
+    class XContentIdentifier;
+    class XDynamicResultSet;
+} } } }
+
+namespace ucb
+{
+
+//=========================================================================
+
+/**
+  * This exception will be thrown from class ucb::Content constructors.
+  */
+class ContentCreationException : public ::com::sun::star::uno::Exception
+{
+public:
+    enum Reason
+    {
+        UNKNOWN,
+        NO_CONTENT_BROKER,
+        NO_IDENTIFIER_FACTORY,
+        IDENTIFIER_CREATION_FAILED,
+        NO_CONTENT_PROVIDER,
+        CONTENT_CREATION_FAILED
+    };
+
+private:
+    Reason m_eReason;
+
+public:
+    ContentCreationException( Reason eReason = UNKNOWN )
+    : m_eReason( eReason ) {}
+
+    const Reason getReason() const { return m_eReason; }
+};
+
+//=========================================================================
+
+/**
+  * These are the possible values for the parameter eMode of method
+  * ucb::Content::createCursor.
+  */
+enum ResultSetInclude
+{
+    INCLUDE_FOLDERS_ONLY,
+    INCLUDE_DOCUMENTS_ONLY,
+    INCLUDE_FOLDERS_AND_DOCUMENTS
+};
+
+//=========================================================================
+
+class Content_Impl;
+
+/**
+  * This class simplifies access to UCB contents by providing a more
+  * convenient API for frequently used functionality then the "raw"
+  * UCB-API does.
+  */
+class Content
+{
+    vos::ORef< Content_Impl > m_xImpl;
+
+public:
+    /**
+      * Constructor.
+      */
+    Content();
+
+    /**
+      * Constructor.
+      *
+      * @param rURL is the URL of the content to create.
+      * @param rEnv is the environment to use for commands executed by the
+      *        content. The command environment is used by the content
+      *        implementation to interact with the client and to propagate
+      *        errors.
+      */
+    Content( const rtl::OUString& rURL,
+             const ::com::sun::star::uno::Reference<
+                    ::com::sun::star::ucb::XCommandEnvironment >& rEnv )
+        throw ( ContentCreationException,
+                ::com::sun::star::uno::RuntimeException );
+    /**
+      * Constructor.
+      *
+      * @param rId is the content identifier of the content to create.
+      * @param rEnv is the environment to use for commands executed by the
+      *        content. The command environment is used by the content
+      *        implementation to interact with the client and to propagate
+      *        errors.
+      */
+    Content( const ::com::sun::star::uno::Reference<
+                     ::com::sun::star::ucb::XContentIdentifier >& rId,
+             const ::com::sun::star::uno::Reference<
+                    ::com::sun::star::ucb::XCommandEnvironment >& rEnv )
+        throw ( ContentCreationException,
+                ::com::sun::star::uno::RuntimeException );
+    /**
+      * Constructor.
+      *
+      * @param rContent is the content object of the content to create.
+      * @param rEnv is the environment to use for commands executed by the
+      *        content. The command environment is used by the content
+      *        implementation to interact with the client and to propagate
+      *        errors.
+      */
+    Content( const ::com::sun::star::uno::Reference<
+                     ::com::sun::star::ucb::XContent >& rContent,
+             const ::com::sun::star::uno::Reference<
+                    ::com::sun::star::ucb::XCommandEnvironment >& rEnv );
+    /**
+      * Copy Constructor.
+      *
+      * @param rContent is the content this content shall be a copy of.
+      */
+    Content( const Content& rOther );
+
+    /**
+      * Destructor.
+      */
+    ~Content();
+
+    /**
+      * Assignment operator.
+      *
+      * @param rContent is the content this content shall be a copy of.
+      */
+    Content& operator=( const Content& rOther );
+
+    //////////////////////////////////////////////////////////////////////
+    // Direct access to UCB content.
+    //////////////////////////////////////////////////////////////////////
+
+    /**
+      * This method provides access to the "native" UCB content interface(s).
+      * This is usefull in case the convenience methods provided by this
+      * class are insufficient for your needs. You may obtain all interfaces
+      * supported by the underlying UCB content by calling this method and
+      * after that doing a queryInterface call.
+      *
+      * @return the XContent interface of the underlying UCB content.
+      */
+    ::com::sun::star::uno::Reference< ::com::sun::star::ucb::XContent >
+    get() const;
+
+    //////////////////////////////////////////////////////////////////////
+    // Access to supported commands/properties.
+    //////////////////////////////////////////////////////////////////////
+
+    /**
+      * This methods provides access to meta data of the commands supported
+      * by this content.
+      *
+      * @return An XCommandInfo interface implementation, which can be used
+      *         to obtain meta data of the commands supported by this content.
+      */
+    ::com::sun::star::uno::Reference< ::com::sun::star::ucb::XCommandInfo >
+    getCommands()
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+    /**
+      * This methods provides access to meta data of the properties supported
+      * by this content.
+      *
+      * @return An XPropertSetInfo interface implementation, which can be used
+      *         to obtain meta data of the properties supported by this content.
+      */
+    ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo >
+    getProperties()
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+
+    //////////////////////////////////////////////////////////////////////
+    // Access to property value(s).
+    //////////////////////////////////////////////////////////////////////
+
+    /**
+      * This method can be used to read a single property value.
+      *
+      * @param  rPropertyName is the name of the property for that the value
+      *         shall be obtained.
+      * @return the property value.
+      */
+    ::com::sun::star::uno::Any
+    getPropertyValue( const rtl::OUString& rPropertyName )
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+    /**
+      * This method can be used to read a single property value.
+      *
+      * @param  nPropertyHande is the handle of the property for that the
+      *         value shall be obtained.
+      * @return the property value.
+      */
+    ::com::sun::star::uno::Any
+    getPropertyValue( sal_Int32 nPropertyHandle )
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+    /**
+      * This method can be used to set a single property value.
+      *
+      * @param  rPropertyName is the name of the property for that the
+      *         value shall be set.
+      */
+    void
+    setPropertyValue( const rtl::OUString& rPropertyName,
+                      const ::com::sun::star::uno::Any& rValue )
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+    /**
+      * This method can be used to set a single property value.
+      *
+      * @param  nPropertyHande is the handle of the property for that the
+      *         value shall be set.
+      */
+    void
+    setPropertyValue( const sal_Int32 nPropertyHandle,
+                      const ::com::sun::star::uno::Any& rValue )
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+    /**
+      * This method can be used to read multiple property values.
+      *
+      * @param  rPropertyNames is a sequence of names of properties for
+      *         that the values shall be obtained.
+      * @return the property values.
+      */
+    ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >
+    getPropertyValues( const ::com::sun::star::uno::Sequence<
+                                rtl::OUString >& rPropertyNames )
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+    /**
+      * This method can be used to read multiple property values.
+      *
+      * @param  nPropertyHandles is a sequence of handles of properties for
+      *         that the values shall be obtained.
+      * @return an XRow interface that can be used to obtain the property
+      *         values.
+      */
+    ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >
+    getPropertyValues( const ::com::sun::star::uno::Sequence<
+                                sal_Int32 >& nPropertyHandles )
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+    /**
+      * This method can be used to read multiple property values.
+      *
+      * @param  rPropertyNames is a sequence of names of properties for
+      *         that the values shall be obtained.
+      * @return the property values.
+      */
+    ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRow >
+    getPropertyValuesInterface( const ::com::sun::star::uno::Sequence<
+                                rtl::OUString >& rPropertyNames )
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+    /**
+      * This method can be used to read multiple property values.
+      *
+      * @param  nPropertyHandles is a sequence of handles of properties for
+      *         that the values shall be obtained.
+      * @return an XRow interface that can be used to obtain the property
+      *         values.
+      */
+    ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRow >
+    getPropertyValuesInterface( const ::com::sun::star::uno::Sequence<
+                                sal_Int32 >& nPropertyHandles )
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+    /**
+      * This method can be used to set multiple property values.
+      *
+      * @param  rPropertyNames is a sequence of names of properties for
+      *         that values shall be set.
+      */
+    void
+    setPropertyValues( const ::com::sun::star::uno::Sequence<
+                                rtl::OUString >& rPropertyNames,
+                       const ::com::sun::star::uno::Sequence<
+                                   ::com::sun::star::uno::Any >& rValues )
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+    /**
+      * This method can be used to set multiple property values.
+      *
+      * @param  nPropertyHandles is a sequence of handles of properties for
+      *         that values shall be set.
+      */
+    void
+    setPropertyValues( const ::com::sun::star::uno::Sequence<
+                                sal_Int32 >& nPropertyHandles,
+                       const ::com::sun::star::uno::Sequence<
+                                   ::com::sun::star::uno::Any >& rValues )
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+
+    //////////////////////////////////////////////////////////////////////
+    // General command execution.
+    //////////////////////////////////////////////////////////////////////
+
+    /**
+      * This method can be used to execute any command supported by the
+      * content.
+      *
+      * @param  rCommandName is the name of the command to execute.
+      * @param  rCommandArgument is the argument for the command. Type and
+      *         values of this parameter must correspond to the command
+      *         specification.
+      * @return the result of the command according to its specification.
+      */
+    ::com::sun::star::uno::Any
+    executeCommand( const rtl::OUString& rCommandName,
+                    const ::com::sun::star::uno::Any& rCommandArgument )
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+    ::com::sun::star::uno::Any
+    /**
+      * This method can be used to execute any command supported by the
+      * content.
+      *
+      * @param  rCommandHandle is the handle of the command to execute.
+      * @param  rCommandArgument is the argument for the command. Type and
+      *         values of this parameter must correspond to the command
+      *         specification.
+      * @return the result of the command according to its specification.
+      */
+    executeCommand( sal_Int32 nCommandHandle,
+                    const ::com::sun::star::uno::Any& rCommandArgument )
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+    /**
+      * This method can be used to abort the command currently executed by
+      * a content. Note that a content can only process one command per
+      * thread at a time. The implementation of the content is responsible
+      * for determining the command to abort when this method is called.
+      */
+    void
+    abortCommand();
+    /**
+      * This method returns the command environment of the content.
+      *
+      * @return the command environment.
+      */
+    ::com::sun::star::uno::Reference<
+        ::com::sun::star::ucb::XCommandEnvironment >
+    getCommandEnvironment();
+
+    //////////////////////////////////////////////////////////////////////
+    // Special commands.
+    //////////////////////////////////////////////////////////////////////
+
+    /**
+      * This methods gives access to the children of a folder content.
+      * Additionally, the result set returned provides efficient access to
+      * preselected property values of the children.
+      * Internally it executes the command "open" at the content.
+      *
+      * @param  rPropertyNames is a sequence of names of properties for
+      *         that the values should be accessable via the resultset
+      *         returned by this method.
+      * @param  eMode is a very simple filter for the children contained
+      *         in the resultset.
+      * @return an implementation of the service
+      *         com.cun.star.ucb.ContentResultSet, which can be used to
+      *         get access to the children of a content.
+      */
+    ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet >
+    createCursor( const ::com::sun::star::uno::Sequence<
+                                rtl::OUString >& rPropertyNames,
+                  ResultSetInclude eMode = INCLUDE_FOLDERS_AND_DOCUMENTS )
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+    /**
+      * This methods gives access to the children of a folder content.
+      * Additionally, the result set returned provides efficient access to
+      * preselected property values of the children.
+      * Internally it executes the command "open" at the content.
+      *
+      * @param nPropertyHandles is a sequence of handles of properties for
+      *        that the values should be accessable via the resultset
+      *        returned by this method.
+      * @param eMode is a very simple filter for the children contained
+      *        in the resultset.
+      * @return an implementation of the service
+      *         com.cun.star.ucb.ContentResultSet, which can be used to
+      *         get access to the children of a content.
+      */
+    ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet >
+    createCursor( const ::com::sun::star::uno::Sequence<
+                                sal_Int32 >& rPropertyHandles,
+                  ResultSetInclude eMode = INCLUDE_FOLDERS_AND_DOCUMENTS )
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+    /**
+      * This methods gives access to the children of a folder content.
+      * Additionally, the result set returned provides efficient access to
+      * preselected property values of the children.
+      * Internally it executes the command "open" at the content.
+      *
+      * @param rPropertyNames is a sequence of names of properties for
+      *        that the values should be accessable via the resultset
+      *        returned by this method.
+      * @param eMode is a very simple filter for the children contained
+      *        in the resultset.
+      * @return an implementation of the service
+      *         com.cun.star.ucb.DynamicResultSet, which can be used to
+      *         get access to the children of a content.
+      */
+    ::com::sun::star::uno::Reference< ::com::sun::star::ucb::XDynamicResultSet >
+    createDynamicCursor( const ::com::sun::star::uno::Sequence<
+                         rtl::OUString >& rPropertyNames,
+                           ResultSetInclude eMode
+                             = INCLUDE_FOLDERS_AND_DOCUMENTS )
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+    /**
+      * This methods gives access to the children of a folder content.
+      * Additionally, the result set returned provides efficient access to
+      * preselected property values of the children.
+      * Internally it executes the command "open" at the content.
+      *
+      * @param nPropertyHandes is a sequence of handles of properties for
+      *        that the values should be accessable via the resultset
+      *        returned by this method.
+      * @param eMode is a very simple filter for the children contained
+      *        in the resultset.
+      * @return an implementation of the service
+      *         com.cun.star.ucb.DynamicResultSet, which can be used to
+      *         get access to the children of a content.
+      */
+    ::com::sun::star::uno::Reference< ::com::sun::star::ucb::XDynamicResultSet >
+    createDynamicCursor( const ::com::sun::star::uno::Sequence<
+                         sal_Int32 >& rPropertyHandles,
+                           ResultSetInclude eMode
+                             = INCLUDE_FOLDERS_AND_DOCUMENTS )
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+    /**
+      * This methods gives read access to the content stream of a content (i.e
+      * the content of a file located at the local file system).
+      * Internally it executes the command "open" at the content.
+      *
+      * @param rSink is the implementation of an XActiveDataSink interface,
+      *        which shall be used by the content to deliver the data.
+      */
+    sal_Bool
+    openStream( const ::com::sun::star::uno::Reference<
+                    ::com::sun::star::io::XActiveDataSink >& rSink )
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+    /**
+      * This methods gives read access to the content stream of a content (i.e
+      * the content of a file located at the local file system).
+      * Internally it executes the command "open" at the content.
+      *
+      * @param rStream is the implementation of an XOutputStream interface,
+      *        which shall be used by the content to deliver the data.
+      */
+    sal_Bool
+    openStream( const ::com::sun::star::uno::Reference<
+                    ::com::sun::star::io::XOutputStream >& rStream )
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+    /**
+      * This methods gives write access to the content stream of a content (i.e
+      * the content of a file located at the local file system).
+      * Internally it executes the command "insert" at the content.
+      *
+      * @param rStream is the implementation of an XInputStream interface,
+      *        which contains the content data to write.
+      * @param bReplaceExisting specifies, whether any existing content data
+      *        shall be overwritten.
+      */
+    void
+    writeStream( const ::com::sun::star::uno::Reference<
+                            ::com::sun::star::io::XInputStream >& rStream,
+                 sal_Bool bReplaceExisting )
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+    /**
+      * This method creates, initializes and inserts ( commits ) a new content
+      * (i.e. it could be used to create a new file system folder).
+      * Internally this method does a XContentCreator::createNewContent(...)-
+      * XCommandProcessor::execute( "setPropertyValues", ... )-
+      * XCommandProcessor::execute( "insert", ... ) calling sequence.
+      *
+      * @param rContentType is the type for the new UCB content. Each content
+      *        provider implementation may introduce own types for its contnt
+      *        objects.
+      * @param rPropertyNames is a sequence of names of properties for that
+      *        values are to set at the new content before it will be inserted
+      *        ( commited ).
+      *        The order of the names must correspond to the order of the
+      *        property values.
+      * @param rPropertyValues is a sequence of property values that are to
+      *        set at the new content before it will be inserted ( commited ).
+      *        The order of the values must correspond to the order of the
+      *        property names.
+      * @param rNewContent will be filled by the implementation of this method
+      *        with the new content.
+      */
+    sal_Bool
+    insertNewContent( const ::rtl::OUString& rContentType,
+                      const ::com::sun::star::uno::Sequence<
+                          rtl::OUString >& rPropertyNames,
+                      const ::com::sun::star::uno::Sequence<
+                          ::com::sun::star::uno::Any >& rPropertyValues,
+                      Content& rNewContent )
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+    /**
+      * This method creates, initializes and inserts ( commits ) a new content
+      * (i.e. it could be used to create a new file system folder).
+      * Internally this method does a XContentCreator::createNewContent(...)-
+      * XCommandProcessor::execute( "setPropertyValues", ... )-
+      * XCommandProcessor::execute( "insert", ... ) calling sequence.
+      *
+      * @param rContentType is the type for the new UCB content. Each content
+      *        provider implementation may introduce own types for its contnt
+      *        objects.
+      * @param nPropertyHandes is a sequence of handles of properties for that
+      *        values are to set at the new content before it will be inserted
+      *        ( commited ).
+      *        The order of the handles must correspond to the order of the
+      *        property values.
+      * @param rPropertyValues is a sequence of property values that are to
+      *        set at the new content before it will be inserted ( commited ).
+      *        The order of the values must correspond to the order of the
+      *        property handles.
+      * @param rNewContent will be filled by the implementation of this method
+      *        with the new content.
+      */
+    sal_Bool
+    insertNewContent( const ::rtl::OUString& rContentType,
+                      const ::com::sun::star::uno::Sequence<
+                        sal_Int32 >& nPropertyHandles,
+                      const ::com::sun::star::uno::Sequence<
+                          ::com::sun::star::uno::Any >& rPropertyValues,
+                      Content& rNewContent )
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+    /**
+      * This method creates, initializes and inserts ( commits ) a new content
+      * (i.e. it could be used to create a new file system folder).
+      * Internally this method does a XContentCreator::createNewContent(...)-
+      * XCommandProcessor::execute( "setPropertyValues", ... )-
+      * XCommandProcessor::execute( "insert", ... ) calling sequence.
+      *
+      * @param rContentType is the type for the new UCB content. Each content
+      *        provider implementation may introduce own types for its contnt
+      *        objects.
+      * @param rPropertyNames is a sequence of names of properties for that
+      *        values are to set at the new content before it will be inserted
+      *        ( commited ).
+      *        The order of the names must correspond to the order of the
+      *        property values.
+      * @param rPropertyValues is a sequence of property values that are to
+      *        set at the new content before it will be inserted ( commited ).
+      *        The order of the values must correspond to the order of the
+      *        property names.
+      * @param rStream is a stream containing the content data for the new
+      *        content (i.e. the content of a file to create)
+      * @param rNewContent will be filled by the implementation of this method
+      *        with the new content.
+      */
+    sal_Bool
+    insertNewContent( const ::rtl::OUString& rContentType,
+                      const ::com::sun::star::uno::Sequence<
+                          rtl::OUString >& rPropertyNames,
+                      const ::com::sun::star::uno::Sequence<
+                          ::com::sun::star::uno::Any >& rPropertyValues,
+                      const ::com::sun::star::uno::Reference<
+                                ::com::sun::star::io::XInputStream >& rStream,
+                      Content& rNewContent )
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+    /**
+      * This method creates, initializes and inserts ( commits ) a new content
+      * (i.e. it could be used to create a new file system folder).
+      * Internally this method does a XContentCreator::createNewContent(...)-
+      * XCommandProcessor::execute( "setPropertyValues", ... )-
+      * XCommandProcessor::execute( "insert", ... ) calling sequence.
+      *
+      * @param rContentType is the type for the new UCB content. Each content
+      *        provider implementation may introduce own types for its contnt
+      *        objects.
+      * @param nPropertyHandes is a sequence of handles of properties for that
+      *        values are to set at the new content before it will be inserted
+      *        ( commited ).
+      *        The order of the handles must correspond to the order of the
+      *        property values.
+      * @param rPropertyValues is a sequence of property values that are to
+      *        set at the new content before it will be inserted ( commited ).
+      *        The order of the values must correspond to the order of the
+      *        property handles.
+      * @param rStream is a stream containing the content data for the new
+      *        content (i.e. the content of a file to create)
+      * @param rNewContent will be filled by the implementation of this method
+      *        with the new content.
+      */
+    sal_Bool
+    insertNewContent( const ::rtl::OUString& rContentType,
+                      const ::com::sun::star::uno::Sequence<
+                        sal_Int32 >& nPropertyHandles,
+                      const ::com::sun::star::uno::Sequence<
+                          ::com::sun::star::uno::Any >& rPropertyValues,
+                      const ::com::sun::star::uno::Reference<
+                                ::com::sun::star::io::XInputStream >& rStream,
+                      Content& rNewContent )
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+
+    //////////////////////////////////////////////////////////////////////
+    // Required properties.
+    //////////////////////////////////////////////////////////////////////
+
+    /** This method returns the value of the content's property "IsFolder".
+      *
+      * @return true, if the content is a folder ( it can contain other
+      *         UCB contents). false, otherwise.
+      */
+    sal_Bool
+    isFolder()
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+    /** This method returns the value of the content's property "IsDocument".
+      *
+      * @return true, if the content is a document ( it has a content stream ).
+      *         false, otherwise.
+      */
+    sal_Bool
+    isDocument()
+        throw( ::com::sun::star::ucb::CommandAbortedException,
+               ::com::sun::star::uno::RuntimeException,
+               ::com::sun::star::uno::Exception );
+};
+
+} /* namespace ucb */
+
+#endif /* !_UCBHELPER_CONTENT_HXX */