1 files changed, 60 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sdb/XDocumentDataSource.idl b/offapi/com/sun/star/sdb/XDocumentDataSource.idl
new file mode 100644
index 000000000..33dbcdb4c
--- /dev/null
+++ b/offapi/com/sun/star/sdb/XDocumentDataSource.idl
@@ -0,0 +1,60 @@
+/* -*- 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_sdb_XDocumentDataSource_idl__
+#define __com_sun_star_sdb_XDocumentDataSource_idl__
+
+#include <com/sun/star/sdb/XOfficeDatabaseDocument.idl>
+
+
+ module com {  module sun {  module star {  module sdb {
+
+/** simplifies the accessing of data sources and their corresponding database document.
+
+    <p>
+    The interface can be used to access the data source of the database document.
+    </p>
+    @see OfficeDatabaseDocument
+ */
+interface XDocumentDataSource
+{
+    /** provides access to the one and only OfficeDatabaseDocument
+        which the data source is based on.
+
+        <p>The component returned by this attribute is an OfficeDatabaseDocument.</p>
+
+        <p>Though there is a 1-to-1 relationship between database documents and data sources,
+        each of the two can exist without its counterpart, but create this counterpart on request
+        only. As a consequence, the document obtained via this attribute might be newly created,
+        which implies that the caller is now responsible for it. In particular, the caller is
+        responsible for calling com::sun::star::util::XCloseable::close()
+        on the document as soon as it's not needed anymore.</p>
+
+        <p>Additionally, if the caller does long-lasting processing on the document, it's advised
+        to add itself as com::sun::star::util::XCloseListener to the document,
+        to prevent closing as long as the processing lasts.</p>
+    */
+    [readonly, attribute] XOfficeDatabaseDocument DatabaseDocument;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */