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

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