summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
commited5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch)
tree7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl
parentInitial commit. (diff)
downloadlibreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.tar.xz
libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.zip
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl')
-rw-r--r--offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl105
1 files changed, 105 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl b/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl
new file mode 100644
index 000000000..ab31a085a
--- /dev/null
+++ b/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl
@@ -0,0 +1,105 @@
+/* -*- 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_XCachedDynamicResultSetStubFactory_idl__
+#define __com_sun_star_ucb_XCachedDynamicResultSetStubFactory_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/ucb/XDynamicResultSet.idl>
+#include <com/sun/star/ucb/NumberedSortingInfo.idl>
+#include <com/sun/star/ucb/XAnyCompareFactory.idl>
+
+
+module com { module sun { module star { module ucb {
+
+/** creates a CachedDynamicResultSetStub and connects a non-remote
+ optimized DynamicResultSet to a remote optimized
+ CachedDynamicResultSet.
+
+ <p>Pay attention to instantiate this helper on server side where your source
+ DynamicResultSet was instantiated.
+
+ <p>Method
+ XCachedDynamicResultSetStubFactory::createCachedDynamicResultSetStub()
+ can be used to create a stub on server side.
+
+ <p>If you have instantiated a CachedDynamicResultSet on client
+ side already, use method connectToCache() to connect your
+ given DynamicResultSet with this Cache.
+
+ <p>The needed cache on server side you can create using
+ XCachedDynamicResultSetFactory.
+*/
+
+published interface XCachedDynamicResultSetStubFactory: com::sun::star::uno::XInterface
+{
+ /** creates a remote optimizes XDynamicResultSet.
+
+ @param Source
+ must be an instance of service DynamicResultSet.
+
+ @returns
+ an instance of service CachedDynamicResultSetStub.
+ */
+
+ com::sun::star::ucb::XDynamicResultSet createCachedDynamicResultSetStub(
+ [in] com::sun::star::ucb::XDynamicResultSet Source );
+
+ /** If you have instantiated a CachedDynamicResultSet on
+ client side already, use this to connect your given Source on server
+ side to the TargetCache.
+
+ @param Source
+ is an instance of service DynamicResultSet.
+
+ @param TargetCache
+ is an instance of service CachedDynamicResultSet.
+
+ @param SortingInfo
+ can be an empty sequence. Otherwise, Source will be sorted according
+ to the given sorting data.
+
+ @param CompareFactory
+ will be ignored unless SortingInfo is not empty. Then the supplied
+ factory will be used to instantiate objects used to compare the
+ properties that are involved in sorting.
+
+ @throws ListenerAlreadySetException
+ if \p Source is already in use.
+
+ @throws AlreadyInitializedException
+ if \p TargetCache already has been initialized.
+ */
+ void connectToCache(
+ [in] com::sun::star::ucb::XDynamicResultSet Source
+ , [in] com::sun::star::ucb::XDynamicResultSet TargetCache
+ , [in] sequence< com::sun::star::ucb::NumberedSortingInfo > SortingInfo
+ , [in] com::sun::star::ucb::XAnyCompareFactory CompareFactory
+ )
+ raises(
+ com::sun::star::ucb::ListenerAlreadySetException
+ , com::sun::star::ucb::AlreadyInitializedException
+ );
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */