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