offapi/com/sun/star/sdb/DefinitionContent.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 #ifndef __com_sun_star_sdb_DefinitionContent_idl__
  28 #define __com_sun_star_sdb_DefinitionContent_idl__
  29
  30 #include <com/sun/star/ucb/Content.idl>
  31 #include <com/sun/star/container/XHierarchicalName.idl>
  32
  33 //=============================================================================
  34
  35 module com { module sun { module star { module sdb {
  36
  37 //=============================================================================
  38
  39 /** defines the basic functionality for an object in the hierarchy of sub documents
  40     of a <type>OfficeDatabaseDocument</type>.
  41
  42     @see DocumentDefinition
  43     @see DocumentContainer
  44  */
  45 service DefinitionContent
  46 {
  47     /** provides the functionality for treating the object as part of a hierarchy
  48         of objects.
  49
  50         <p>The following commands are commonly supported by the <type scope="com::sun::star::ucb">XCommandProcessor</type>
  51         implementation of a <code>DefinitionContent</code>:
  52         <ul>
  53             <li><strong>getPropertyValues</strong></li>
  54             <li><strong>setPropertyValues</strong></li>
  55             <li><strong>getPropertysetInfo</strong></li>
  56         </ul>
  57         </p>
  58
  59         <p>Additional commands might be supported by derived services.</p>
  60     */
  61     service ::com::sun::star::ucb::Content;
  62
  63     /** provides access to the complete name of the content within its hierarchy
  64         @since OOo 3.3
  65     */
  66     interface ::com::sun::star::container::XHierarchicalName;
  67 };
  68
  69 //=============================================================================
  70
  71 }; }; }; };
  72
  73 //=============================================================================
  74
  75 #endif
  76