1*d1766043SAndrew Rist/************************************************************** 2*d1766043SAndrew Rist * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_sdb_XDocumentDataSource_idl__ 24cdf0e10cSrcweir#define __com_sun_star_sdb_XDocumentDataSource_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_sdb_XOfficeDatabaseDocument_idl__ 27cdf0e10cSrcweir#include <com/sun/star/sdb/XOfficeDatabaseDocument.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir//============================================================================= 31cdf0e10cSrcweir 32cdf0e10cSrcweir module com { module sun { module star { module sdb { 33cdf0e10cSrcweir 34cdf0e10cSrcweir//============================================================================= 35cdf0e10cSrcweir/** simplifies the accessing of data sources and their corresponding database document. 36cdf0e10cSrcweir 37cdf0e10cSrcweir <p> 38cdf0e10cSrcweir The interface can be used to access the data source of the database document. 39cdf0e10cSrcweir </p> 40cdf0e10cSrcweir @see OfficeDatabaseDocument 41cdf0e10cSrcweir */ 42cdf0e10cSrcweirpublished interface XDocumentDataSource 43cdf0e10cSrcweir{ 44cdf0e10cSrcweir /** provides access to the one and only <type>OfficeDatabaseDocument</type> 45cdf0e10cSrcweir which the data source is based on. 46cdf0e10cSrcweir 47cdf0e10cSrcweir <p>The component returned by this attribute is an <type>OfficeDatabaseDocument</type>.</p> 48cdf0e10cSrcweir 49cdf0e10cSrcweir <p>Though there is a 1-to-1 relationship between database documents and data sources, 50cdf0e10cSrcweir each of the two can exist without its counterpart, but create this counterpart on request 51cdf0e10cSrcweir only. As a consequence, the document obtained via this attribute might be newly created, 52cdf0e10cSrcweir which implies that the caller is now responsible for it. In particular, the caller is 53cdf0e10cSrcweir responsible for calling <member scope="com::sun::star::util">XCloseable::close</member> 54cdf0e10cSrcweir on the document as soon as it's not needed anymore.</p> 55cdf0e10cSrcweir 56cdf0e10cSrcweir <p>Additionally, if the caller does long-lasting processing on the document, it's advised 57cdf0e10cSrcweir to add itself as <type scope="com::sun::star::util">XCloseListener</type> to the document, 58cdf0e10cSrcweir to prevent closing as long as the processing lasts.</p> 59cdf0e10cSrcweir */ 60cdf0e10cSrcweir [readonly, attribute] XOfficeDatabaseDocument DatabaseDocument; 61cdf0e10cSrcweir}; 62cdf0e10cSrcweir 63cdf0e10cSrcweir//============================================================================= 64cdf0e10cSrcweir 65cdf0e10cSrcweir}; }; }; }; 66cdf0e10cSrcweir 67cdf0e10cSrcweir/*============================================================================= 68cdf0e10cSrcweir 69cdf0e10cSrcweir=============================================================================*/ 70cdf0e10cSrcweir#endif 71cdf0e10cSrcweir 72