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_XIdentifierReplace_idl__
24#define __com_sun_star_container_XIdentifierReplace_idl__
25
26#ifndef __com_sun_star_container_XIdentifierAccess_idl__
27#include <com/sun/star/container/XIdentifierAccess.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_NoSuchElementException_idl__
35#include <com/sun/star/container/NoSuchElementException.idl>
36#endif
37
38#ifndef __com_sun_star_lang_WrappedTargetException_idl__
39#include <com/sun/star/lang/WrappedTargetException.idl>
40#endif
41
42
43//=============================================================================
44
45module com {  module sun {  module star {  module container {
46
47//=============================================================================
48
49/** This is the generic interface for supporting the replacement of elements
50	with unique identifiers.
51*/
52published interface XIdentifierReplace: com::sun::star::container::XIdentifierAccess
53{
54	/** replaces the element with the specified identifier.
55
56		@param Identifier
57			specifies the identifier of the element that should be retrieved.
58
59		@param aElement
60			the new element that replaces the old element for the specified identifier.
61
62		@throws com::sun::star::lang::IllegalArgumentException
63			If the argument is not valid for this container.
64
65		@throws com::sun::star::lang::NoSuchElementException
66			If the identifier is not existing.
67
68		@throws  com::sun::star::lang::WrappedTargetException
69			If the implementation has internal reasons for exceptions,
70			then wrap these in a <type scope="com::sun::star::lang">WrappedTargetException</type>
71			exception.
72	 */
73	void replaceByIdentifer( [in] long Identifier,
74			 [in] any aElement )
75			raises( com::sun::star::lang::IllegalArgumentException,
76					com::sun::star::container::NoSuchElementException,
77					com::sun::star::lang::WrappedTargetException );
78
79};
80
81//=============================================================================
82
83}; }; }; };
84
85#endif
86