udkapi/com/sun/star/container/XImplicitIDContainer.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_container_XImplicitIDContainer_idl__
  28 #define __com_sun_star_container_XImplicitIDContainer_idl__
  29
  30 #ifndef __com_sun_star_container_XImplicitIDReplace_idl__
  31 #include <com/sun/star/container/XImplicitIDReplace.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  35 #include <com/sun/star/container/NoSuchElementException.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_lang_WrappedTargetException_idl__
  39 #include <com/sun/star/lang/WrappedTargetException.idl>
  40 #endif
  41
  42
  43 //=============================================================================
  44
  45 module com {  module sun {  module star {  module container {
  46
  47 /** makes it possible to insert and remove elements in/from a container
  48     using an implicit (unique) ID.
  49  */
  50 published interface XImplicitIDContainer: com::sun::star::container::XImplicitIDReplace
  51 {
  52     /** adds a new object to the container and generates an implicit (unique)
  53         ID for this object.
  54
  55         @returns
  56             the implicit ID for the new object.
  57      */
  58     string addWithImplicitID( [in] any aElement );
  59
  60     /** removes an object from the container which is specified by
  61         an implicit (unique) identifier.
  62      */
  63     void removeByImplicitID( [in] string ID )
  64         raises( com::sun::star::container::NoSuchElementException );
  65 };
  66
  67 //=============================================================================
  68
  69 }; }; }; };
  70
  71 /*=============================================================================
  72
  73 =============================================================================*/
  74 #endif