udkapi/com/sun/star/container/XImplicitIDContainer.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_XImplicitIDContainer_idl__
  20 #define __com_sun_star_container_XImplicitIDContainer_idl__
  21
  22 #include <com/sun/star/container/XImplicitIDReplace.idl>
  23
  24 #include <com/sun/star/container/NoSuchElementException.idl>
  25
  26 #include <com/sun/star/lang/WrappedTargetException.idl>
  27
  28
  29
  30 module com {  module sun {  module star {  module container {
  31
  32 /** makes it possible to insert and remove elements in/from a container
  33     using an implicit (unique) ID.
  34  */
  35 published interface XImplicitIDContainer: com::sun::star::container::XImplicitIDReplace
  36 {
  37     /** adds a new object to the container and generates an implicit (unique)
  38         ID for this object.
  39
  40         @returns
  41             the implicit ID for the new object.
  42      */
  43     string addWithImplicitID( [in] any aElement );
  44
  45     /** removes an object from the container which is specified by
  46         an implicit (unique) identifier.
  47      */
  48     void removeByImplicitID( [in] string ID )
  49         raises( com::sun::star::container::NoSuchElementException );
  50 };
  51
  52
  53 }; }; }; };
  54
  55 #endif
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */