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