udkapi/com/sun/star/container/XUniqueIDAccess.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_XUniqueIDAccess_idl__
  28 #define __com_sun_star_container_XUniqueIDAccess_idl__
  29
  30 #ifndef __com_sun_star_container_XElementAccess_idl__
  31 #include <com/sun/star/container/XElementAccess.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 module com {  module sun {  module star {  module container {
  45
  46 /** makes it possible to access contents via a unique ID.
  47  */
  48 published interface XUniqueIDAccess: com::sun::star::uno::XInterface
  49 {
  50     /** @returns
  51         the element with the specified unique ID.
  52      */
  53     any getByUniqueID( [in] string ID ) raises( com::sun::star::container::NoSuchElementException );
  54
  55     /** removes the element with the specified unique ID from this
  56         container.
  57      */
  58     void removeByUniqueID( [in] string ID ) raises( com::sun::star::container::NoSuchElementException );
  59 };
  60
  61 //=============================================================================
  62
  63 }; }; }; };
  64
  65 #endif