udkapi/com/sun/star/container/XUniqueIDAccess.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_container_XUniqueIDAccess_idl__
  20 #define __com_sun_star_container_XUniqueIDAccess_idl__
  21
  22 #include <com/sun/star/container/XElementAccess.idl>
  23
  24 #include <com/sun/star/container/NoSuchElementException.idl>
  25
  26 #include <com/sun/star/lang/WrappedTargetException.idl>
  27
  28
  29 module com {  module sun {  module star {  module container {
  30
  31 /** makes it possible to access contents via a unique ID.
  32  */
  33 published interface XUniqueIDAccess: com::sun::star::uno::XInterface
  34 {
  35     /** @returns
  36         the element with the specified unique ID.
  37      */
  38     any getByUniqueID( [in] string ID ) raises( com::sun::star::container::NoSuchElementException );
  39
  40     /** removes the element with the specified unique ID from this
  41         container.
  42      */
  43     void removeByUniqueID( [in] string ID ) raises( com::sun::star::container::NoSuchElementException );
  44 };
  45
  46
  47 }; }; }; };
  48
  49 #endif
  50
  51 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */