#96518# new service description for ODMA access

2 files changed, 349 insertions, 0 deletions

diff --git a/offapi/com/sun/star/ucb/ODMAContent.idl b/offapi/com/sun/star/ucb/ODMAContent.idl
new file mode 100644
index 000000000000..24a92e044974
--- /dev/null
+++ b/offapi/com/sun/star/ucb/ODMAContent.idl
@@ -0,0 +1,227 @@
+/*************************************************************************
+ *
+ *  $RCSfile: ODMAContent.idl,v $
+ *
+ *  $Revision: 1.1 $
+ *
+ *  last change: $Author: oj $ $Date: 2002-03-25 10:48:26 $
+ *
+ *  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 __com_sun_star_ucb_ODMAContent_idl__
+#define __com_sun_star_ucb_ODMAContent_idl__
+
+#ifndef __com_sun_star_lang_XComponent_idl__
+#include <com/sun/star/lang/XComponent.idl>
+#endif
+
+#ifndef __com_sun_star_ucb_XContent_idl__
+#include <com/sun/star/ucb/XContent.idl>
+#endif
+
+#ifndef __com_sun_star_ucb_XCommandProcessor_idl__
+#include <com/sun/star/ucb/XCommandProcessor.idl>
+#endif
+
+#ifndef __com_sun_star_beans_XPropertiesChangeNotifier_idl__
+#include <com/sun/star/beans/XPropertiesChangeNotifier.idl>
+#endif
+
+#ifndef __com_sun_star_beans_XPropertyContainer_idl__
+#include <com/sun/star/beans/XPropertyContainer.idl>
+#endif
+
+#ifndef __com_sun_star_beans_XPropertySetInfoChangeNotifier_idl__
+#include <com/sun/star/beans/XPropertySetInfoChangeNotifier.idl>
+#endif
+
+#ifndef __com_sun_star_ucb_XCommandInfoChangeNotifier_idl__
+#include <com/sun/star/ucb/XCommandInfoChangeNotifier.idl>
+#endif
+
+#ifndef __com_sun_star_container_XChild_idl__
+#include <com/sun/star/container/XChild.idl>
+#endif
+
+//=============================================================================
+
+module com { module sun { module star { module ucb {
+
+//=============================================================================
+/** A OCP content is representation of a document saved in a DMS.
+
+    <p>The document Content corresponds to a document stored in a Document Management System.
+    </p>
+
+    @see com::sun::star::ucb::ODMAContentProvider
+    @see com::sun::star::ucb::Content
+*/
+service ODMAContent
+{
+    //-------------------------------------------------------------------------
+    /** This interface is implemented according to the specification of
+        service <type>Content</type>.
+     */
+    interface com::sun::star::lang::XComponent;
+
+    //-------------------------------------------------------------------------
+    /** This interface is implemented according to the specification of
+        service <type>Content</type>.
+     */
+    interface com::sun::star::ucb::XContent;
+
+    //-------------------------------------------------------------------------
+    /** This interface is implemented according to the specification of
+        service <type>Content</type>.
+
+        <p>
+
+        <b>Supported Commands</b>
+        <ul>
+        <li>
+        getCommandInfo
+        </li>
+        <li>
+        getPropertySetInfo
+        </li>
+        <li>
+        getPropertyValues
+        </li>
+        <li>
+        setPropertyValues
+        </li>
+        <li>
+        delete
+        </li>
+        <li>
+        open
+        </li>
+        <li>
+        close
+        </li>
+        </ul>
+
+        <b>Supported Properties</b>
+        <ul>
+        <li>
+        string ContentType ( read-only, always "application/vnd.sun.star.odma" )
+        </li>
+        <li>
+        boolean IsDocument
+        </li>
+        <li>
+        boolean IsFolder
+        </li>
+        <li>
+        <type scope="com::sun::star::util">DateTime</type> DateCreated ( read-only )
+        </li>
+        <li>
+        <type scope="com::sun::star::util">DateTime</type> DateModified ( read-only )
+        </li>
+        <li>
+        string Author
+        </li>
+        <li>
+        string Subject
+        </li>
+        <li>
+        string Keywords
+        </li>
+        <li>
+        string Size ( read-only )
+        </li>
+        <li>
+        string Title
+        </li>
+        </ul>
+
+        </p>
+     */
+    interface com::sun::star::ucb::XCommandProcessor;
+
+    //-------------------------------------------------------------------------
+    /** This interface is implemented according to the specification of
+        service <type>Content</type>.
+     */
+    interface com::sun::star::beans::XPropertiesChangeNotifier;
+
+    //-------------------------------------------------------------------------
+    /** This interface is implemented according to the specification of
+        service <type>Content</type>.
+     */
+    interface com::sun::star::beans::XPropertyContainer;
+
+    //-------------------------------------------------------------------------
+    /** This interface is implemented according to the specification of
+        service <type>Content</type>.
+     */
+    interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
+
+    //-------------------------------------------------------------------------
+    /** This interface is implemented according to the specification of
+        service <type>Content</type>.
+     */
+    interface com::sun::star::ucb::XCommandInfoChangeNotifier;
+
+    //-------------------------------------------------------------------------
+    /** This interface is implemented according to the specification of
+        service <type>Content</type>.
+     */
+    interface com::sun::star::container::XChild;
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif
diff --git a/offapi/com/sun/star/ucb/ODMAContentProvider.idl b/offapi/com/sun/star/ucb/ODMAContentProvider.idl
new file mode 100644
index 000000000000..966e8a2a4911
--- /dev/null
+++ b/offapi/com/sun/star/ucb/ODMAContentProvider.idl
@@ -0,0 +1,122 @@
+/*************************************************************************
+ *
+ *  $RCSfile: ODMAContentProvider.idl,v $
+ *
+ *  $Revision: 1.1 $
+ *
+ *  last change: $Author: oj $ $Date: 2002-03-25 10:48:19 $
+ *
+ *  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 __com_sun_star_ucb_ODMAContentProvider_idl__
+#define __com_sun_star_ucb_ODMAContentProvider_idl__
+
+#ifndef __com_sun_star_ucb_XContentProvider_idl__
+#include <com/sun/star/ucb/XContentProvider.idl>
+#endif
+
+//=============================================================================
+
+module com { module sun { module star { module ucb {
+
+//=============================================================================
+/** The ODMA Content Provider (OCP) implements a <type>ContentProvider</type>
+    for the <type>UniversalContentBroker</type> (UCB).
+
+    <p>It provides access to a document structure stored on a Document Management System (DMS).</p>
+
+
+    @see com::sun::star::ucb::ContentProvider
+    @see com::sun::star::ucb::Content
+    @see com::sun::star::ucb::ODMAContent
+*/
+service ODMAContentProvider
+{
+    //-------------------------------------------------------------------------
+    /** provides two types of content; the document and the Root Folder.
+
+        <p>
+
+        <ol>
+        <li><p>The document Content corresponds to a document stored on the
+            DMS.</p>
+        <li><p>The Root Folder exists at any time and is used to show all
+            documents avaible at that time. All other OCP contents are children
+            of this folder. The OCP Root Folder can only contain OCP Documents.
+            It has the URL &bdquo;<b>vnd.sun.star.odma:/</b>&ldquo;.</p>
+        </ol>
+
+
+
+        <p><b>URL Scheme for OCP Contents</b>
+        <p>Each OCP content has an identifier corresponding to the following
+        scheme:</p>
+        <p>vnd.sun.star.odma:/&lt;name&gt;</p>
+        <p>where &lt;name&gt; is the DocumentID given by the DMS.</p>
+        <p STYLE="font-weight: medium">Examples:</p>
+        <p><b>vnd.sun.star.odma:/ </b><span STYLE="font-weight: medium">( The
+        URL of the OCP Root Folder )</span></p>
+        <p STYLE="font-weight: medium"><b>vnd.sun.star.odma:/</b> a document
+        id given by the DMS</p>
+        <p><b>vnd.sun.star.odma:/</b>::ODMA\DMS_ID\DM_SPECIFIC_INFO</p>
+
+        </p>
+     */
+    interface com::sun::star::ucb::XContentProvider;
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif