1 files changed, 98 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ucb/XParameterizedContentProvider.idl b/offapi/com/sun/star/ucb/XParameterizedContentProvider.idl
new file mode 100644
index 000000000..f57d98367
--- /dev/null
+++ b/offapi/com/sun/star/ucb/XParameterizedContentProvider.idl
@@ -0,0 +1,98 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   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 .
+ */
+#ifndef __com_sun_star_ucb_XParameterizedContentProvider_idl__
+#define __com_sun_star_ucb_XParameterizedContentProvider_idl__
+
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#include <com/sun/star/ucb/XContentProvider.idl>
+#include <com/sun/star/uno/XInterface.idl>
+
+
+
+module com { module sun { module star { module ucb {
+
+/** Register specially adjusted instances of content providers on URL
+    templates and supplementary arguments.
+
+    @version 1.0
+*/
+published interface XParameterizedContentProvider: com::sun::star::uno::XInterface
+{
+    /** Register a content provider on a URL template and supplementary
+        arguments.
+
+        @param Template  A URL template.  If the input is malformed or too
+        complex, a com::sun::star::lang::IllegalArgumentException may be raised.
+
+        @param Arguments  Any supplementary arguments required by this
+        XContentProvider, represented as a single string.  If the
+        input is malformed, an
+        com::sun::star::lang::IllegalArgumentException
+        may be raised.
+
+        @param ReplaceExisting  If true, and if the given Template conflicts
+        with an already registered instance, the old registration is replaced
+        by the new one.  If false, and if the given Template conflicts with an
+        already registered instance, the new registration is not performed,
+        and null is returned.
+
+        @return  Either this XContentProvider, or another,
+        specially adjusted version of this XContentProvider (this
+        flexibility allows for different implementation strategies), or null
+        if the given Template conflicts with an already registered instance
+        and ReplaceExisting is false.  Note that the returned
+        XContentProvider must still be registered at the content
+        provider manager!
+    */
+    com::sun::star::ucb::XContentProvider
+    registerInstance([in] string Template,
+                     [in] string Arguments,
+                     [in] boolean ReplaceExisting)
+        raises (com::sun::star::lang::IllegalArgumentException);
+
+    /** Deregisters a content provider.
+
+        @param Template  A URL template.  If the input is malformed or too
+        complex, an IllegalArgumentException may be raised.
+
+        @param Arguments  Any supplementary arguments required by this
+        XContentProvider, represented as a single string.  If the
+        input is malformed, an
+        com::sun::star::lang::IllegalArgumentException
+        may be raised.
+
+        @return  Either this XContentProvider, or another,
+        specially adjusted version of this XContentProvider (this
+        flexibility allows for different implementation strategies), or null
+        if no instance is registered for the given Template.  Note that the
+        returned XContentProvider must still be deregistered at
+        the content provider manager!
+    */
+    com::sun::star::ucb::XContentProvider
+    deregisterInstance([in] string Template,
+                       [in] string Arguments)
+        raises (com::sun::star::lang::IllegalArgumentException);
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */