<html> <head> <title>Service OfficeDatabaseDocument</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="OfficeDatabaseDocument-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#ServicesSummary" class="navisub">Services' Summary</a></td> <td class="navisub"><a href="#InterfacesSummary" class="navisub">Interfaces' Summary</a></td> <td class="navisub">Properties' Summary</td> <td class="navisub"><a href="#ServicesDetails" class="navisub">Services' Details</a></td> <td class="navisub"><a href="#InterfacesDetails" class="navisub">Interfaces' Details</a></td> <td class="navisub">Properties' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">sdb</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">service OfficeDatabaseDocument</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>specifies a office database document which is a storable document. </dd> <dd><p>These documents contain information about forms, and reports, and the properties of a data source.</p> <p>The database document contains no data per default. The following is stored inside the document: <ul> <li>forms</li> <li>reports</li> <li>The table settings defined in <a href="DataSettings.html">DataSettings</a></li> <li>The query settings defined in <a href="DataSettings.html">DataSettings</a></li> <li>All properties of the service <a href="DataSource.html">DataSource</a></li> </ul></p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 2.0</dd> <dt><b>See also</b></dt> <dd><a href="XOfficeDatabaseDocument.html">XOfficeDatabaseDocument</a>, ::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/OfficeDocument.html">OfficeDocument</a></dd> </dl> </td> </tr> </table> <hr> <a name="ServicesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services - Summary</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/OfficeDocument.html">OfficeDocument</a></td> <td class="imsum_right"><p>specifies basic functionality of a document in OpenOffice.org (<a href="#OfficeDocument">details</a>)</p> </td> </tr> </table> <a name="InterfacesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Summary</td> </tr> <tr> <td class="imsum_left"><a href="XOfficeDatabaseDocument.html">XOfficeDatabaseDocument</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>simplifies the accessing of data sources, and it's corresponding database document and forms, and reports. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/XEmbeddedScripts.html">XEmbeddedScripts</a></td> <td class="imsum_right"><p>allows access to the Basic macros and dialogs possibly embedded in the document (<a href="#XEmbeddedScripts">details</a>)</p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::script::<a href="../script/provider/module-ix.html">provider</a>::<a href="../script/provider/XScriptProviderSupplier.html">XScriptProviderSupplier</a></td> <td class="imsum_right"><p>supplies a script provider which can be used to execute macros and scripts embedded in the document (<a href="#XScriptProviderSupplier">details</a>)</p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XLoadable.html">XLoadable</a></td> <td class="imsum_right"><p>allows to initialize the the document, either from scratch, or from a stored database document. (<a href="#XLoadable">details</a>)</p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/XDocumentEventBroadcaster.html">XDocumentEventBroadcaster</a></td> <td class="imsum_right"><p>allows to register for notifications happening in the document (<a href="#XDocumentEventBroadcaster">details</a>)</p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XCloseable.html">XCloseable</a></td> <td class="imsum_right"><p>implements life time control (<a href="#XCloseable">details</a>)</p> </td> </tr> </table> <a name="ServicesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services - Details</td> </tr> <tr/> <tr> <td class="imdetail"><a name="OfficeDocument" class="membertitle">::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/OfficeDocument.html">OfficeDocument</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>specifies basic functionality of a document in OpenOffice.org </dd> <dd><p>Note that a database document actually does not support the ::com::sun::star::<a href="../view/module-ix.html">view</a>::<a href="../view/XPrintable.html">XPrintable</a> interface. The non-optional requirement of this interface in the ::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/OfficeDocument.html">OfficeDocument</a> service is considered a documentation error.</p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="InterfacesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Details</td> </tr> <tr/> <tr> <td class="imdetail"><a name="XOfficeDatabaseDocument" class="membertitle"><a href="XOfficeDatabaseDocument.html">XOfficeDatabaseDocument</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt>(referenced entity's summary:)</dt> <dd>simplifies the accessing of data sources, and it's corresponding database document and forms, and reports. </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XEmbeddedScripts" class="membertitle">::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/XEmbeddedScripts.html">XEmbeddedScripts</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>allows access to the Basic macros and dialogs possibly embedded in the document </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.1</dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XScriptProviderSupplier" class="membertitle">::com::sun::star::script::<a href="../script/provider/module-ix.html">provider</a>::<a href="../script/provider/XScriptProviderSupplier.html">XScriptProviderSupplier</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>supplies a script provider which can be used to execute macros and scripts embedded in the document </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.1</dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XLoadable" class="membertitle">::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XLoadable.html">XLoadable</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>allows to initialize the the document, either from scratch, or from a stored database document. </dd> <dd><p>A newly instantiated database document cannot be operated until it is fully initialized. There are three possible means to do this initialization: <ul><li>calling <code>XLoadable::initNew</code></li> <li>calling <code>XLoadable::load</code></li> <li>calling <code>XStorable::storeAsURL</code></li> </ul> The third option was added for compatibility reasons, since a <a href="DatabaseDocument.html">DatabaseDocument</a> in earlier versions of OpenOffice.org did not support the <code>XLoadable</code> interface, so the usual way of creating a document from scratch was to create it, set properties as needed, and store it.</p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.1</dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XDocumentEventBroadcaster" class="membertitle">::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/XDocumentEventBroadcaster.html">XDocumentEventBroadcaster</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>allows to register for notifications happening in the document </dd> <dd><p>The following events are broadcasted by a database document <table border="1" frame="all"> <thead> <tr><td><strong>Event Name</strong></td> <td><strong>broadcasted when</strong></td> <td align="center"><strong>broadcasted synchronously</strong></td> </tr> </thead> <tbody> <tr><td valign="top"><em>OnCreate</em></td> <td>the document has been newly created. This does not imply that the document has been loaded into a frame, it just means the initialization has been finished.</td> <td align="center">yes</td> </tr> <tr><td valign="top"><em>OnLoadFinished</em></td> <td>the document has been completely loaded. This does not imply that the document has been loaded into a frame, it just means the load process has been finished.</td> <td align="center">yes</td> </tr> <tr><td valign="top"><em>OnNew</em></td> <td>the document has been initialized from scratch, including plugging it into a frame.</td> <td align="center">no</td> </tr> <tr><td valign="top"><em>OnLoad</em></td> <td>the document has been completely loaded, including plugging it into a frame.</td> <td align="center">no</td> </tr> <tr><td valign="top"><em>OnSave</em></td> <td>the document is about to be saved.</td> <td align="center">yes</td> </tr> <tr><td valign="top"><em>OnSaveDone</em></td> <td>saving the document succeeeded.</td> <td align="center">no</td> </tr> <tr><td valign="top"><em>OnSaveFailed</em></td> <td>saving the document failed.</td> <td align="center">no</td> </tr> <tr><td valign="top"><em>OnSaveAs</em></td> <td>the document is about to be saved under a new name.</td> <td align="center">yes</td> </tr> <tr><td valign="top"><em>OnSaveAsDone</em></td> <td>saving the document under a new name succeeeded.</td> <td align="center">no</td> </tr> <tr><td valign="top"><em>OnSaveAsFailed</em></td> <td>saving the document under a new name failed.</td> <td align="center">no</td> </tr> <tr><td valign="top"><em>OnSaveTo</em></td> <td>the document is about to be saved to a location different from its current location, but without adjusting the current location.</td> <td align="center">yes</td> </tr> <tr><td valign="top"><em>OnSaveToDone</em></td> <td>saving the document to a different location succeeeded.</td> <td align="center">no</td> </tr> <tr><td valign="top"><em>OnSaveToFailed</em></td> <td>saving the document to a different location failed.</td> <td align="center">no</td> </tr> <tr><td valign="top"><em>OnPrepareUnload</em></td> <td>the document is about to be closed.</td> <td align="center">yes</td> </tr> <tr><td valign="top"><em>OnUnload</em></td> <td>the document is being closed.</td> <td align="center">yes</td> </tr> <tr><td valign="top"><em>OnFocus</em></td> <td>a view to the document obtained the focus.</td> <td align="center">no</td> </tr> <tr><td valign="top"><em>OnUnfocus</em></td> <td>a view to the document lost the focus.</td> <td align="center">no</td> </tr> <tr><td valign="top"><em>OnModifyChanged</em></td> <td>the <quot>modified</quot> state of the document changed.</td> <td align="center">no</td> </tr> <tr><td valign="top"><em>OnViewCreated</em></td> <td>a view to the document has been created, and attached to the document.</td> <td align="center">no</td> </tr> <tr><td valign="top"><em>OnPrepareViewClosing</em></td> <td>a view to the document is about to be closed.</td> <td align="center">yes</td> </tr> <tr><td valign="top"><em>OnViewClosed</em></td> <td>a view to the document has been closed.</td> <td align="center">no</td> </tr> <tr><td valign="top"><em>OnTitleChanged</em></td> <td>the title of the document changed.</td> <td align="center">no</td> </tr> <tr><td valign="top"><em>OnSubComponentOpened</em></td> <td>From with a view to the document, a view to a sub component (e.g. a table or a report) has been opened.</td> <td align="center">no</td> </tr> <tr><td valign="top"><em>OnSubComponentClosed</em></td> <td>From with a view to the document, a view to a sub component (e.g. a table or a report) has been closed.</td> <td align="center">no</td> </tr> </tbody> </table> </p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.1</dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XCloseable" class="membertitle">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XCloseable.html">XCloseable</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>implements life time control </dd> <dd><p>Whoever retrieves a <a href="OfficeDatabaseDocument.html">OfficeDatabaseDocument</a> should be aware of life time issues, since a document needs to be closed when nobody needs it anymore.</p> <p>This implies that clients of a document need to ensure that as soon as they don't need, they invoke ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XCloseable.html">XCloseable</a>::<a href="../util/XCloseable.html#close">close</a>.</p> <p>Since this can be done by multiple clients, every client is additionally required to register itself as ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XCloseListener.html">XCloseListener</a> at the document, to prevent some other client closing the model while it's still needed by the first client.</p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
5212
