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