xref: /trunk/main/offapi/com/sun/star/ucb/ODMAContentProvider.idl (revision 34c958ab)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#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

    @since OpenOffice 1.1.2
*/
published 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