udkapi/com/sun/star/container/XIdentifierReplace.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_XIdentifierReplace_idl__
  28 #define __com_sun_star_container_XIdentifierReplace_idl__
  29
  30 #ifndef __com_sun_star_container_XIdentifierAccess_idl__
  31 #include <com/sun/star/container/XIdentifierAccess.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_NoSuchElementException_idl__
  39 #include <com/sun/star/container/NoSuchElementException.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_lang_WrappedTargetException_idl__
  43 #include <com/sun/star/lang/WrappedTargetException.idl>
  44 #endif
  45
  46
  47 //=============================================================================
  48
  49 module com {  module sun {  module star {  module container {
  50
  51 //=============================================================================
  52
  53 /** This is the generic interface for supporting the replacement of elements
  54     with unique identifiers.
  55 */
  56 published interface XIdentifierReplace: com::sun::star::container::XIdentifierAccess
  57 {
  58     /** replaces the element with the specified identifier.
  59
  60         @param Identifier
  61             specifies the identifier of the element that should be retrieved.
  62
  63         @param aElement
  64             the new element that replaces the old element for the specified identifier.
  65
  66         @throws com::sun::star::lang::IllegalArgumentException
  67             If the argument is not valid for this container.
  68
  69         @throws com::sun::star::lang::NoSuchElementException
  70             If the identifier is not existing.
  71
  72         @throws  com::sun::star::lang::WrappedTargetException
  73             If the implementation has internal reasons for exceptions,
  74             then wrap these in a <type scope="com::sun::star::lang">WrappedTargetException</type>
  75             exception.
  76      */
  77     void replaceByIdentifer( [in] long Identifier,
  78              [in] any aElement )
  79             raises( com::sun::star::lang::IllegalArgumentException,
  80                     com::sun::star::container::NoSuchElementException,
  81                     com::sun::star::lang::WrappedTargetException );
  82
  83 };
  84
  85 //=============================================================================
  86
  87 }; }; }; };
  88
  89 #endif