offapi/com/sun/star/sdb/XDataAccessDescriptorFactory.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_sdb_XDataAccessDescriptorFactory_idl__
  29 #define __com_sun_star_sdb_XDataAccessDescriptorFactory_idl__
  30
  31 #ifndef __com_sun_star_beans_XPropertySet_idl__
  32 #include <com/sun/star/beans/XPropertySet.idl>
  33 #endif
  34
  35 //=============================================================================
  36
  37 module com { module sun { module star { module sdb {
  38
  39 //=============================================================================
  40
  41 /** allows creating instances of the DataAccessDescriptor service.
  42
  43     <p>Data access descriptors are finally only bags of properties with a defined
  44     semantics. Depending on the context in which you use them, certain of their
  45     properties are needed or unneeded.<br/>
  46     The descriptor factory allows you to create instances which offer
  47     all properties potentially needed at a descriptor.</p>
  48  */
  49 interface XDataAccessDescriptorFactory
  50 {
  51     /** creates a <type>DataAccessDescriptor</type> which supports all properties
  52         defined for this service, even if they're normally optional only.
  53     */
  54     ::com::sun::star::beans::XPropertySet
  55         createDataAccessDescriptor();
  56 };
  57
  58 //=============================================================================
  59
  60 }; }; }; };
  61
  62 //=============================================================================
  63
  64 #endif