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_linguistic2_XThesaurus_idl__
24#define __com_sun_star_linguistic2_XThesaurus_idl__
25
26#ifndef __com_sun_star_linguistic2_XSupportedLocales_idl__
27#include <com/sun/star/linguistic2/XSupportedLocales.idl>
28#endif
29
30#ifndef __com_sun_star_linguistic2_XMeaning_idl__
31#include <com/sun/star/linguistic2/XMeaning.idl>
32#endif
33
34#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
35#include <com/sun/star/lang/IllegalArgumentException.idl>
36#endif
37
38#ifndef __com_sun_star_beans_PropertyValues_idl__
39#include <com/sun/star/beans/PropertyValues.idl>
40#endif
41
42//=============================================================================
43
44module com { module sun { module star { module linguistic2 {
45
46//=============================================================================
47/** allows for the retrieval of possible meanings for a given word and language.
48
49	<P>
50 	The meaning of a word is in essence a descriptive text for that word.
51 	Each meaning may have several synonyms where a synonym is a word
52 	(or small text) with the same or similar meaning.
53	</P>
54
55    @see    <type scope="com::sun::star::linguistic2">XSupportedLocales</type>
56*/
57published interface XThesaurus : com::sun::star::linguistic2::XSupportedLocales
58{
59	//-------------------------------------------------------------------------
60	/**
61		@returns
62			a list of meanings for the given word and language.
63
64	 	@param	aTerm
65	 		the word to query for its meanings.
66
67		@param	aLocale
68			specifies the language of the word.
69
70			<P>If the language is not supported, an
71			<type scope="com::sun::star::lang">IllegalArgumentException</type>
72			exception is raised.</P>
73
74		@param aProperties
75			provides property values to be used for this function call only.
76			It is usually empty in order to use the default values supplied with
77			the property set.
78
79        @see    <type scope="com::sun::star::lang">Locale</type>
80        @see    <type scope="com::sun::star::linguistic2">XMeaning</type>
81	*/
82	sequence< com::sun::star::linguistic2::XMeaning > queryMeanings(
83			[in] string aTerm,
84		 	[in] com::sun::star::lang::Locale aLocale,
85			[in] com::sun::star::beans::PropertyValues aProperties )
86		raises( com::sun::star::lang::IllegalArgumentException );
87
88};
89
90//=============================================================================
91
92}; }; }; };
93
94#endif
95
96