/* -*- 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 .
*/
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;
};
}; }; }; };
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
