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