/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_linguistic2_XThesaurus_idl__
#define __com_sun_star_linguistic2_XThesaurus_idl__

#include <com/sun/star/linguistic2/XSupportedLocales.idl>
#include <com/sun/star/linguistic2/XMeaning.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>
#include <com/sun/star/beans/PropertyValues.idl>


module com { module sun { module star { module linguistic2 {

/** allows for the retrieval of possible meanings for a given word and language.

    <P>
     The meaning of a word is in essence a descriptive text for that word.
     Each meaning may have several synonyms where a synonym is a word
     (or small text) with the same or similar meaning.
    </P>

    @see    com::sun::star::linguistic2::XSupportedLocales
*/
published interface XThesaurus : com::sun::star::linguistic2::XSupportedLocales
{
    /**
        @returns
            a list of meanings for the given word and language.

         @param aTerm
             the word to query for its meanings.

        @param  aLocale
            specifies the language of the word.

            <P>If the language is not supported, an
            com::sun::star::lang::IllegalArgumentException
            exception is raised.</P>

        @param aProperties
            provides property values to be used for this function call only.
            It is usually empty in order to use the default values supplied with
            the property set.

        @see    com::sun::star::lang::Locale
        @see    com::sun::star::linguistic2::XMeaning
    */
    sequence< com::sun::star::linguistic2::XMeaning > queryMeanings(
            [in] string aTerm,
             [in] com::sun::star::lang::Locale aLocale,
            [in] com::sun::star::beans::PropertyValues aProperties )
        raises( com::sun::star::lang::IllegalArgumentException );

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */