offapi/com/sun/star/sdbcx/Descriptor.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20  module com {  module sun {  module star {  module sdbcx {
  21
  22
  23 /** is used to create a new object within a database.
  24
  25     <p>
  26     A descriptor is commonly created by the container of a specific object, such as, tables or views.
  27     After the creation of the descriptor the properties have to be filled.
  28     Afterwards, you append the descriptor to the container and the container creates a new object based
  29     on the information of the descriptor. The descriptor can be used to create several objects.
  30     </p>
  31     <p>
  32     A descriptor contains at least the information of the name of an object.
  33     </p>
  34     @see com::sun::star::sdbcx::XAppend
  35  */
  36 published service Descriptor
  37 {
  38     // gives access to the properties.
  39     interface com::sun::star::beans::XPropertySet;
  40
  41
  42     /** is the name for the object to create.
  43      */
  44     [property] string Name;
  45 };
  46
  47
  48 }; }; }; };
  49
  50 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */