udkapi/com/sun/star/container/XNameContainer.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_XNameContainer_idl__
  28 #define __com_sun_star_container_XNameContainer_idl__
  29
  30 #ifndef __com_sun_star_container_XNameReplace_idl__
  31 #include <com/sun/star/container/XNameReplace.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  35 #include <com/sun/star/lang/IllegalArgumentException.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_container_ElementExistException_idl__
  39 #include <com/sun/star/container/ElementExistException.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_lang_WrappedTargetException_idl__
  43 #include <com/sun/star/lang/WrappedTargetException.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  47 #include <com/sun/star/container/NoSuchElementException.idl>
  48 #endif
  49
  50 //=============================================================================
  51
  52 module com {  module sun {  module star {  module container {
  53
  54 //=============================================================================
  55
  56 /** This is the generic interface for supporting the insertion and removal of
  57     named elements.
  58     @see XContainer
  59  */
  60 published interface XNameContainer: com::sun::star::container::XNameReplace
  61 {
  62     //-------------------------------------------------------------------------
  63
  64     /** inserts the given element at the specified name.
  65      */
  66     void insertByName( [in] string aName,
  67              [in] any aElement )
  68             raises( com::sun::star::lang::IllegalArgumentException,
  69                     com::sun::star::container::ElementExistException,
  70                     com::sun::star::lang::WrappedTargetException );
  71
  72     //-------------------------------------------------------------------------
  73
  74     /** removes the element with the specified name.
  75      */
  76     void removeByName( [in] string Name )
  77             raises( com::sun::star::container::NoSuchElementException,
  78                     com::sun::star::lang::WrappedTargetException );
  79
  80 };
  81
  82 //=============================================================================
  83
  84 }; }; }; };
  85
  86 #endif