xref: /trunk/main/offapi/com/sun/star/ucb/XAnyCompare.idl (revision cdf0e10c) 
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_ucb_XAnyCompare_idl__
28#define __com_sun_star_ucb_XAnyCompare_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34//=============================================================================
35
36module com { module sun { module star { module ucb {
37
38//=============================================================================
39/** compares two <atom>any</atom>s.
40*/
41
42published interface XAnyCompare: com::sun::star::uno::XInterface
43{
44	//-------------------------------------------------------------------------
45	/**	allows comparision of two <atom>any</atom>s.
46
47		@param Any1
48		is the first compare value
49
50		@param Any2
51		is the second compare value
52
53		@returns
54		<ul>
55		<li>
56		<code>-1</code>, if the first any is less than the second ( Any1 &lt; Any2 )
57		</li>
58		<li>
59		<code>0</code>, if the first any is equal to the second ( Any1 == Any2 )
60		</li>
61		<li>
62		<code>+1</code>, if the first any is greater than the second ( Any1 &gt; Any2 )
63		</li>
64		</ul>
65	*/
66
67	short	compare( [in] any Any1, [in] any Any2 );
68};
69
70//=============================================================================
71
72}; }; }; };
73
74#endif
75