/*************************************************************************
 *
 *  $RCSfile: XCollator.idl,v $
 *
 *  $Revision: 1.4.18.2 $
 *
 *  last change: $Author: mi $ $Date: 2003/01/21 17:44:43 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_i18n_XCollator_idl__
#define __com_sun_star_i18n_XCollator_idl__

#include <com/sun/star/uno/Exception.idl>
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/lang/Locale.idl>
//=============================================================================

module com { module sun { module star { module i18n { 

/** Interface for collation algorithms used in sorting.
*/
interface XCollator: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** Compare 2 substrings.

        @param aStr1
            First string.

        @param nOff1
            Offset (from 0) of the first substring.

        @param nLen1
            Length (from offset) of the first substring.

        @param aStr2
            Second string

        @param nOff2
            Offset (from 0) of the second substring.

        @param nLen2
            Length (from offset) of the second substring.

        @returns
            1 if the first string is greater than the second string <br/>
            0 if the first string is equal to the second string <br/>
            -1 if the first string is less than the second string
    */
    long compareSubstring(  [in] string aStr1, [in] long nOff1, [in] long nLen1,
                            [in] string aStr2, [in] long nOff2, [in] long nLen2 );

    //-------------------------------------------------------------------------
    /** Compare 2 strings.

        @param aStr1
            First string.

        @param aStr2
            Second string.

        @returns
            1 if the first string is greater than the second string <br/>
            0 if the first string is equal to the second string <br/>
            -1 if the first string is less than the second string
    */
    long compareString( [in] string aStr1, [in] string aStr2 );

    //-------------------------------------------------------------------------
    /** Load the default collator.

        @param aLocale
            The locale for this collator.

        @param nCollatorOptions
            A mask of <type>CollatorOptions</type>.

        @returns
            TODO
    */
    long loadDefaultCollator(   [in] ::com::sun::star::lang::Locale aLocale,
                                [in] long nCollatorOptions );

    //-------------------------------------------------------------------------
    /** Load a particular collator algorithm.

        @param aAlgorithmName
            Fhe algorithm to load.

        @param aLocale
            The locale for this collator.

        @param nCollatorOptions
            A mask of <type>CollatorOptions</type>.

        @returns
            TODO
    */
    long loadCollatorAlgorithm( [in] string aAlgorithmName,
                                [in] ::com::sun::star::lang::Locale aLocale,
                                [in] long nCollatorOptions );

    //-------------------------------------------------------------------------
    /** List all collator algorithms for a given locale.

        @param aLocale
            The locale for which to list algorithms.

        @returns
            A sequence of algorithm names.
    */
    sequence <string> listCollatorAlgorithms(
                                [in] ::com::sun::star::lang::Locale aLocale );
 
    //-------------------------------------------------------------------------
    /** Load a collator algorithm with options chosen by end user.

        @param aAlgorithmName
            The algorithm name to load.

        @param aLocale
            The locale for this collator.

        @param aCollatorOptions
            A sequence of end user collator options like those returned
            by <member>XCollator::listCollatorOptions()</member>.
    */
    void loadCollatorAlgorithmWithEndUserOption(
                                [in] string aAlgorithmName,
                                [in] ::com::sun::star::lang::Locale aLocale,
                                [in] sequence<long> aCollatorOptions );

    //-------------------------------------------------------------------------
    /** List all end user collator options for a given algorithm.

        @param aAlgorithmName
            The algorithm name for this collator.

        @returns
            An array of end user options available for the algorithm.
    */
    sequence <long> listCollatorOptions( [in] string aAlgorithmName );

};

//=============================================================================

}; }; }; }; 

//=============================================================================

#endif
