offapi/com/sun/star/ucb/XAnyCompare.idl

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