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