xref: /aoo41x/main/udkapi/com/sun/star/container/XSet.idl (revision 408a4873)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_container_XSet_idl__
24#define __com_sun_star_container_XSet_idl__
25
26#ifndef __com_sun_star_container_XEnumerationAccess_idl__
27#include <com/sun/star/container/XEnumerationAccess.idl>
28#endif
29
30#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
31#include <com/sun/star/lang/IllegalArgumentException.idl>
32#endif
33
34#ifndef __com_sun_star_container_ElementExistException_idl__
35#include <com/sun/star/container/ElementExistException.idl>
36#endif
37
38#ifndef __com_sun_star_container_NoSuchElementException_idl__
39#include <com/sun/star/container/NoSuchElementException.idl>
40#endif
41
42//=============================================================================
43
44module com {  module sun {  module star {  module container {
45
46//=============================================================================
47
48/** This is the generic interface for supporting the insertion and removal of
49	elements.@see XContainer
50 */
51published interface XSet: com::sun::star::container::XEnumerationAccess
52{
53	//-------------------------------------------------------------------------
54
55	/** @returns
56		<TRUE/> if the given element is a member of this container,
57		otherwise <FALSE/>.
58	 */
59	boolean has( [in] any aElement );
60
61	//-------------------------------------------------------------------------
62
63	/** inserts the given element into this container.
64	 */
65	void insert( [in] any aElement )
66			raises( com::sun::star::lang::IllegalArgumentException,
67					com::sun::star::container::ElementExistException );
68
69	//-------------------------------------------------------------------------
70
71	/** removes the given element from this container.
72	 */
73	void remove( [in] any aElement )
74			raises( com::sun::star::lang::IllegalArgumentException,
75					com::sun::star::container::NoSuchElementException );
76
77};
78
79//=============================================================================
80
81}; }; }; };
82
83#endif
84