offapi/com/sun/star/sdb/DefinitionContainer.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: DefinitionContainer.idl,v $
  10  * $Revision: 1.12 $
  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_DefinitionContainer_idl__
  31 #define __com_sun_star_sdb_DefinitionContainer_idl__
  32
  33  module com {  module sun {  module star {  module container {
  34  published interface XNameAccess;
  35  published interface XNameContainer;
  36  published interface XIndexAccess;
  37  published interface XEnumerationAccess;
  38 };};};};
  39
  40  module com {  module sun {  module star {  module util {
  41  published interface XRefreshable;
  42 };};};};
  43  module com {  module sun {  module star {  module lang {
  44  published interface XSingleServiceFactory;
  45 };};};};
  46
  47  module com {  module sun {  module star {  module sdb {
  48
  49
  50 /** describes a container which provides access to database related definitions like
  51     commands, forms, and reports.
  52
  53     <p>
  54     The container supports access to its elements by the elements name or
  55     by the elements position.
  56     </p>
  57     <p>
  58     Simple enumeration must be supported as well.
  59     </p>
  60     <p>
  61     To reflect the changes with the underlying database, a refresh mechanism
  62     needs to be supported.
  63     </p>
  64  */
  65 published service DefinitionContainer
  66 {
  67     // gives access to the elements by name.
  68     interface com::sun::star::container::XNameAccess;
  69
  70     // allows to insert and remove by name.
  71     interface com::sun::star::container::XNameContainer;
  72
  73     // gives access to the elements by index.
  74     interface com::sun::star::container::XIndexAccess;
  75
  76     // allows to create an enumeration of the elements.
  77     interface com::sun::star::container::XEnumerationAccess;
  78
  79
  80     /** is used to refresh the container, to reflect changes in the underlying database.
  81      */
  82     [optional] interface com::sun::star::util::XRefreshable;
  83
  84     /** can be used to create container elements.
  85         <p>
  86         If this interface is supported, the object created using it (e.g., the object returned by
  87         <method scope="com.sun.star.lang">XSingleServiceFactory::createInstance()</method>
  88         ) can be used as container elements.
  89         </p>
  90      */
  91     [optional] interface com::sun::star::lang::XSingleServiceFactory;
  92 };
  93
  94 //=============================================================================
  95
  96 }; }; }; };
  97
  98 /*===========================================================================
  99 ===========================================================================*/
 100 #endif