summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/ucb/XContentProvider.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/ucb/XContentProvider.idl')
-rw-r--r--offapi/com/sun/star/ucb/XContentProvider.idl103
1 files changed, 103 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ucb/XContentProvider.idl b/offapi/com/sun/star/ucb/XContentProvider.idl
new file mode 100644
index 000000000000..1422441a8879
--- /dev/null
+++ b/offapi/com/sun/star/ucb/XContentProvider.idl
@@ -0,0 +1,103 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org 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 version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org. If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_ucb_XContentProvider_idl__
+#define __com_sun_star_ucb_XContentProvider_idl__
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.idl>
+#endif
+
+#ifndef __com_sun_star_ucb_XContentIdentifier_idl__
+#include <com/sun/star/ucb/XContentIdentifier.idl>
+#endif
+
+#ifndef __com_sun_star_ucb_XContent_idl__
+#include <com/sun/star/ucb/XContent.idl>
+#endif
+
+#ifndef __com_sun_star_ucb_IllegalIdentifierException_idl__
+#include <com/sun/star/ucb/IllegalIdentifierException.idl>
+#endif
+
+//=============================================================================
+
+module com { module sun { module star { module ucb {
+
+//=============================================================================
+/** a content provider which creates and manages <type>XContent</type>s.
+
+ @version 1.0
+ @author Kai Sommerfeld
+ @see XContent
+ @see XContentIdentifier
+*/
+published interface XContentProvider: com::sun::star::uno::XInterface
+{
+ //-------------------------------------------------------------------------
+ /** creates a new <type>XContent</type> instance, if the given
+ <type>XContentIdentifier</type> matches a content provided by the
+ implementation of this interface.
+
+ @param Identifier
+ an identifier for the content to query.
+
+ @returns
+ the content.
+
+ @throws IllegalIdentifierException
+ if the given identifier does not match a content provided by the
+ implementation of this interface
+ */
+ com::sun::star::ucb::XContent queryContent(
+ [in] com::sun::star::ucb::XContentIdentifier Identifier )
+ raises ( com::sun::star::ucb::IllegalIdentifierException );
+
+ //-------------------------------------------------------------------------
+ /** compares two <type>XContentIdentifier</type>s.
+
+ @param Id1
+ first content identifier.
+
+ @param Id2
+ second content identifier.
+
+ @returns
+ <code>0</code> is returned, if the identifiers are equal.
+ A value less than <code>0</code> indiactes, that the Id1
+ is less than Id2. A value greater than <code>0</code>
+ is returned, if Id1 is greater than Id2.
+ */
+ long compareContentIds(
+ [in] com::sun::star::ucb::XContentIdentifier Id1,
+ [in] com::sun::star::ucb::XContentIdentifier Id2 );
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif