offapi/com/sun/star/sdbcx/Container.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: Container.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_Container_idl__
  31 #define __com_sun_star_sdbcx_Container_idl__
  32
  33  module com {  module sun {  module star {  module container {
  34  published interface XNameAccess;
  35  published interface XIndexAccess;
  36  published interface XEnumerationAccess;
  37 };};};};
  38
  39  module com {  module sun {  module star {  module util {
  40  published interface XRefreshable;
  41 };};};};
  42
  43  module com {  module sun {  module star {  module sdbcx {
  44
  45  published interface XDataDescriptorFactory;
  46  published interface XAppend;
  47  published interface XDrop;
  48
  49
  50 /** describes every container which is used for data definition. Each
  51     container must support access to its elements by the element's name or
  52     by the element's position.
  53
  54     <p>
  55     Simple enumeration must be supported as well.
  56     </p>
  57     <p>
  58     To reflect the changes with the underlying database, a refresh mechanism
  59     needs to be supported.
  60     </p>
  61     <p>
  62     A container may support the possibility to add new elements or to drop
  63     existing elements. Additions are always done by descriptors which define the
  64     properties of the new element.
  65     </p>
  66  */
  67 published service Container
  68 {
  69     // gives access to the elements by name.
  70     interface com::sun::star::container::XNameAccess;
  71
  72     // gives access to the elements by index.
  73     interface com::sun::star::container::XIndexAccess;
  74
  75     // used to create an enumeration of the elements.
  76     interface com::sun::star::container::XEnumerationAccess;
  77
  78
  79     /** is optional for implementation. Used to reflect changes.
  80      */
  81     [optional] interface com::sun::star::util::XRefreshable;
  82
  83     /** optional for implementation. Allows to create descriptor elements which then could be used to append new elements.
  84      */
  85     [optional] interface XDataDescriptorFactory;
  86
  87     /** optional for implementation, provides the possibility of adding
  88                 a new element to the container.
  89      */
  90     [optional] interface XAppend;
  91
  92     /** optional for implementation, provides the possibility of dropping
  93                 an element from the container.
  94      */
  95     [optional] interface XDrop;
  96 };
  97
  98 //=============================================================================
  99
 100 }; }; }; };
 101
 102 /*===========================================================================
 103 ===========================================================================*/
 104 #endif