udkapi/com/sun/star/container/XSet.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_XSet_idl__
  28 #define __com_sun_star_container_XSet_idl__
  29
  30 #ifndef __com_sun_star_container_XEnumerationAccess_idl__
  31 #include <com/sun/star/container/XEnumerationAccess.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_container_NoSuchElementException_idl__
  43 #include <com/sun/star/container/NoSuchElementException.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module container {
  49
  50 //=============================================================================
  51
  52 /** This is the generic interface for supporting the insertion and removal of
  53     elements.@see XContainer
  54  */
  55 published interface XSet: com::sun::star::container::XEnumerationAccess
  56 {
  57     //-------------------------------------------------------------------------
  58
  59     /** @returns
  60         <TRUE/> if the given element is a member of this container,
  61         otherwise <FALSE/>.
  62      */
  63     boolean has( [in] any aElement );
  64
  65     //-------------------------------------------------------------------------
  66
  67     /** inserts the given element into this container.
  68      */
  69     void insert( [in] any aElement )
  70             raises( com::sun::star::lang::IllegalArgumentException,
  71                     com::sun::star::container::ElementExistException );
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** removes the given element from this container.
  76      */
  77     void remove( [in] any aElement )
  78             raises( com::sun::star::lang::IllegalArgumentException,
  79                     com::sun::star::container::NoSuchElementException );
  80
  81 };
  82
  83 //=============================================================================
  84
  85 }; }; }; };
  86
  87 #endif