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