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