udkapi/com/sun/star/container/XIdentifierContainer.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_XIdentifierContainer_idl__
  28 #define __com_sun_star_container_XIdentifierContainer_idl__
  29
  30 #ifndef __com_sun_star_container_XIdentifierReplace_idl__
  31 #include <com/sun/star/container/XIdentifierReplace.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_ElementExistException_idl__
  39 #include <com/sun/star/container/ElementExistException.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_lang_WrappedTargetException_idl__
  43 #include <com/sun/star/lang/WrappedTargetException.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  47 #include <com/sun/star/container/NoSuchElementException.idl>
  48 #endif
  49
  50 //=============================================================================
  51
  52 module com {  module sun {  module star {  module container {
  53
  54 //=============================================================================
  55
  56 /** This is the generic interface for supporting the creation and removal of
  57     elements with unique identifiers.
  58
  59     @see XContainer
  60  */
  61 published interface XIdentifierContainer: com::sun::star::container::XIdentifierReplace
  62 {
  63     //-------------------------------------------------------------------------
  64
  65     /** inserts an element and creates a new unique identifier for it.
  66
  67         @returns
  68             the newly created identifier under which the element is inserted.
  69
  70         @param aElement
  71             The new element that will be inserted.
  72
  73         @throws com::sun::star::lang::IllegalArgumentException
  74             if the argument is not vailid for this container.
  75
  76         @throws  com::sun::star::lang::WrappedTargetException
  77             If the implementation has internal reasons for exceptions,
  78             then wrap these in a <type scope="com::sun::star::lang">WrappedTargetException</type>
  79             exception.
  80
  81      */
  82     long insert( [in] any aElement )
  83             raises( com::sun::star::lang::IllegalArgumentException,
  84                     com::sun::star::lang::WrappedTargetException );
  85
  86     //-------------------------------------------------------------------------
  87
  88     /** removes the element with the specified identifier.
  89
  90         @param Identifier
  91             The identifier that should be removed.
  92
  93         @throws com::sun::star::lang::NoSuchElementException
  94             If the identifier does not exist.
  95
  96         @throws  com::sun::star::lang::WrappedTargetException
  97             If the implementation has internal reasons for exceptions,
  98             then wrap these in a <type scope="com::sun::star::lang">WrappedTargetException</type>
  99             exception.
 100      */
 101     void removeByIdentifier( [in] long Identifier )
 102             raises( com::sun::star::container::NoSuchElementException,
 103                     com::sun::star::lang::WrappedTargetException );
 104
 105 };
 106
 107 //=============================================================================
 108
 109 }; }; }; };
 110
 111 #endif