xref: /trunk/main/udkapi/com/sun/star/container/XSet.idl (revision cdf0e10c)
1*cdf0e10cSrcweir/*************************************************************************
2*cdf0e10cSrcweir *
3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir *
5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir *
7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir *
9*cdf0e10cSrcweir * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir *
11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir *
15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir *
21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir *
26*cdf0e10cSrcweir ************************************************************************/
27*cdf0e10cSrcweir#ifndef __com_sun_star_container_XSet_idl__
28*cdf0e10cSrcweir#define __com_sun_star_container_XSet_idl__
29*cdf0e10cSrcweir
30*cdf0e10cSrcweir#ifndef __com_sun_star_container_XEnumerationAccess_idl__
31*cdf0e10cSrcweir#include <com/sun/star/container/XEnumerationAccess.idl>
32*cdf0e10cSrcweir#endif
33*cdf0e10cSrcweir
34*cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
35*cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl>
36*cdf0e10cSrcweir#endif
37*cdf0e10cSrcweir
38*cdf0e10cSrcweir#ifndef __com_sun_star_container_ElementExistException_idl__
39*cdf0e10cSrcweir#include <com/sun/star/container/ElementExistException.idl>
40*cdf0e10cSrcweir#endif
41*cdf0e10cSrcweir
42*cdf0e10cSrcweir#ifndef __com_sun_star_container_NoSuchElementException_idl__
43*cdf0e10cSrcweir#include <com/sun/star/container/NoSuchElementException.idl>
44*cdf0e10cSrcweir#endif
45*cdf0e10cSrcweir
46*cdf0e10cSrcweir//=============================================================================
47*cdf0e10cSrcweir
48*cdf0e10cSrcweirmodule com {  module sun {  module star {  module container {
49*cdf0e10cSrcweir
50*cdf0e10cSrcweir//=============================================================================
51*cdf0e10cSrcweir
52*cdf0e10cSrcweir/** This is the generic interface for supporting the insertion and removal of
53*cdf0e10cSrcweir	elements.@see XContainer
54*cdf0e10cSrcweir */
55*cdf0e10cSrcweirpublished interface XSet: com::sun::star::container::XEnumerationAccess
56*cdf0e10cSrcweir{
57*cdf0e10cSrcweir	//-------------------------------------------------------------------------
58*cdf0e10cSrcweir
59*cdf0e10cSrcweir	/** @returns
60*cdf0e10cSrcweir		<TRUE/> if the given element is a member of this container,
61*cdf0e10cSrcweir		otherwise <FALSE/>.
62*cdf0e10cSrcweir	 */
63*cdf0e10cSrcweir	boolean has( [in] any aElement );
64*cdf0e10cSrcweir
65*cdf0e10cSrcweir	//-------------------------------------------------------------------------
66*cdf0e10cSrcweir
67*cdf0e10cSrcweir	/** inserts the given element into this container.
68*cdf0e10cSrcweir	 */
69*cdf0e10cSrcweir	void insert( [in] any aElement )
70*cdf0e10cSrcweir			raises( com::sun::star::lang::IllegalArgumentException,
71*cdf0e10cSrcweir					com::sun::star::container::ElementExistException );
72*cdf0e10cSrcweir
73*cdf0e10cSrcweir	//-------------------------------------------------------------------------
74*cdf0e10cSrcweir
75*cdf0e10cSrcweir	/** removes the given element from this container.
76*cdf0e10cSrcweir	 */
77*cdf0e10cSrcweir	void remove( [in] any aElement )
78*cdf0e10cSrcweir			raises( com::sun::star::lang::IllegalArgumentException,
79*cdf0e10cSrcweir					com::sun::star::container::NoSuchElementException );
80*cdf0e10cSrcweir
81*cdf0e10cSrcweir};
82*cdf0e10cSrcweir
83*cdf0e10cSrcweir//=============================================================================
84*cdf0e10cSrcweir
85*cdf0e10cSrcweir}; }; }; };
86*cdf0e10cSrcweir
87*cdf0e10cSrcweir#endif
88