xref: /aoo41x/main/offapi/com/sun/star/ucb/XAnyCompare.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_ucb_XAnyCompare_idl__
24#define __com_sun_star_ucb_XAnyCompare_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30//=============================================================================
31
32module com { module sun { module star { module ucb {
33
34//=============================================================================
35/** compares two <atom>any</atom>s.
36*/
37
38published interface XAnyCompare: com::sun::star::uno::XInterface
39{
40	//-------------------------------------------------------------------------
41	/**	allows comparision of two <atom>any</atom>s.
42
43		@param Any1
44		is the first compare value
45
46		@param Any2
47		is the second compare value
48
49		@returns
50		<ul>
51		<li>
52		<code>-1</code>, if the first any is less than the second ( Any1 &lt; Any2 )
53		</li>
54		<li>
55		<code>0</code>, if the first any is equal to the second ( Any1 == Any2 )
56		</li>
57		<li>
58		<code>+1</code>, if the first any is greater than the second ( Any1 &gt; Any2 )
59		</li>
60		</ul>
61	*/
62
63	short	compare( [in] any Any1, [in] any Any2 );
64};
65
66//=============================================================================
67
68}; }; }; };
69
70#endif
71