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