summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/ucb/XContentIdentifier.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/ucb/XContentIdentifier.idl')
-rw-r--r--offapi/com/sun/star/ucb/XContentIdentifier.idl121
1 files changed, 121 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ucb/XContentIdentifier.idl b/offapi/com/sun/star/ucb/XContentIdentifier.idl
new file mode 100644
index 000000000000..160f1971fd09
--- /dev/null
+++ b/offapi/com/sun/star/ucb/XContentIdentifier.idl
@@ -0,0 +1,121 @@
+/*************************************************************************
+ *
+ * $RCSfile: XContentIdentifier.idl,v $
+ *
+ * $Revision: 1.1 $
+ *
+ * last change: $Author: mi $ $Date: 2000-11-06 09:22:31 $
+ *
+ * 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_XContentIdentifier_idl__
+#define __com_sun_star_ucb_XContentIdentifier_idl__
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.idl>
+#endif
+
+
+//=============================================================================
+
+module com { module sun { module star { module ucb {
+
+//=============================================================================
+/** An identifier for contents.
+
+ @version 1.0
+ @author Kai Sommerfeld
+ @see XContent
+*/
+[ uik(E2281A04-33D6-11D1-AABE00A0-249D5590), ident( "XContentIdentifier", 1.0 ) ]
+interface XContentIdentifier: com::sun::star::uno::XInterface
+{
+ //-------------------------------------------------------------------------
+ /** returns the content identifier string.
+
+ @returns
+ the content identifier string. This must be a valid URI
+ (Uniform Resource Identifier, see RFC 2396). This string
+ is required. If a content provider 'implements' some
+ existent URI scheme (e.g., a content provider offering
+ access to a file system would implement the 'file' scheme,
+ and a content provider offering access to IMAP servers
+ would implement the 'imap' scheme), the content identifier
+ strings should use that scheme. If on the other hand a
+ content provider offers access to content for which no
+ appropriate URI scheme exists, a vendor-specific URL scheme
+ starting with 'vnd.' must be created (see the Internet Draft
+ draft-king-vnd-urlscheme-00.txt).
+ */
+ string getContentIdentifier();
+
+ //-------------------------------------------------------------------------
+ /** returns the content provider scheme string. This string will
+ be calculated from the content identifier string and must be
+ lower-cased(!). It is the 'scheme' the content provider is
+ registered for. In example, a provider for FTP contents will
+ use ftp-URL's as content identifiers. The content provider
+ scheme for all contents provided by that provider will be "ftp".
+
+ @returns
+ the content provider scheme string.
+ */
+ string getContentProviderScheme();
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif