xref: /trunk/main/offapi/com/sun/star/util/XChainable.idl (revision d1766043) 
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_util_XChainable_idl__
24#define __com_sun_star_util_XChainable_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
31#include <com/sun/star/lang/IllegalArgumentException.idl>
32#endif
33
34
35//=============================================================================
36
37module com {  module sun {  module star {  module util {
38
39//=============================================================================
40
41/** enables the object to be a member of a chain.
42 */
43published interface XChainable: com::sun::star::uno::XInterface
44{
45	//-------------------------------------------------------------------------
46	/** @returns
47				the previous object in this chain or NULL, if this is the first
48				object of this chain.
49	 */
50	com::sun::star::util::XChainable getPredecessor();
51
52	//-------------------------------------------------------------------------
53	/** @returns
54				the next object in this chain or NULL, if this is the last
55				object in this chain.
56	 */
57	com::sun::star::util::XChainable getSuccessor();
58
59	//-------------------------------------------------------------------------
60	/** connects the specified object to this object as the successor in a chain.
61
62		<p>This implies that this object will become the predecessor of
63		<var>xChainable</var>.  </p>
64	 */
65	void setSuccessor( [in] com::sun::star::util::XChainable xChainable )
66			raises( com::sun::star::lang::IllegalArgumentException );
67
68	//-------------------------------------------------------------------------
69	/** checks if the specified object can be linked to this.
70	 */
71	boolean isChainable( [in] com::sun::star::util::XChainable xChainable );
72
73};
74
75//=============================================================================
76
77}; }; }; };
78
79#endif
80