offapi/com/sun/star/sdbcx/Descriptor.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: Descriptor.idl,v $
  10  * $Revision: 1.11 $
  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 #ifndef __com_sun_star_sdbcx_Descriptor_idl__
  31 #define __com_sun_star_sdbcx_Descriptor_idl__
  32
  33 #ifndef __com_sun_star_beans_XPropertySet_idl__
  34 #include <com/sun/star/beans/XPropertySet.idl>
  35 #endif
  36
  37  module com {  module sun {  module star {  module sdbcx {
  38
  39
  40 /** is used to create a new object within a database.
  41
  42     <p>
  43     A descriptor is commonly created by the container of a specific object, such as, tables or views.
  44     After the creation of the descriptor the properties have to be filled.
  45     Afterwards, you append the descriptor to the container and the container creates a new object based
  46     on the informations of the descriptor. The descriptor can be used to create serveral objects.
  47     </p>
  48     <p>
  49     A descriptor containes at least the informations of the name of an object.
  50     </p>
  51     @see com::sun::star::sdbcx::XAppend
  52  */
  53 published service Descriptor
  54 {
  55     // gives access to the properties.
  56     interface com::sun::star::beans::XPropertySet;
  57
  58
  59     /** is the name for the object to create.
  60      */
  61     [property] string Name;
  62 };
  63
  64 //=============================================================================
  65
  66 }; }; }; };
  67
  68 /*===========================================================================
  69 ===========================================================================*/
  70 #endif