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_mozilla_XProfileDiscover_idl__
28#define __com_sun_star_mozilla_XProfileDiscover_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33#ifndef __com_sun_star_mozilla_MozillaProductType_idl__
34#include <com/sun/star/mozilla/MozillaProductType.idl>
35#endif
36
37
38 module com {  module sun {  module star {  module mozilla {
39
40
41
42/** is the interface used to list and get information for Mozilla/Thunderbird profiles
43
44
45	@see com::sun::star::mozilla::XProfileManager
46	@see com::sun::star::mozilla::MozillaBootstrap
47 */
48published interface XProfileDiscover: com::sun::star::uno::XInterface
49{
50
51	/** attempts to get the profiles count.
52
53		@param product
54			is the product name to get profiles count.Currently support "Mozilla" and "Thunderbird".
55		@returns
56			the profiles count of selected product.
57
58	 */
59	long getProfileCount( [in]MozillaProductType product);
60
61	/** attempts to get the profile list for the given product.
62
63		@param product
64			is the product name to get profile list.Currently support "Mozilla" and "Thunderbird".
65		@param list
66			is a list of all profile of the given product.
67		@returns
68			the profile count for the given product.
69
70	 */
71	long getProfileList( [in]MozillaProductType product,[out] sequence<string> list);
72
73	/** attempts to get the default profile name for the given product.
74
75		@param product
76			is the product name to get default profile.Currently support "Mozilla" and "Thunderbird".
77		@returns
78			the default profile name for the given product.
79
80	 */
81	string getDefaultProfile( [in]MozillaProductType product);
82
83
84	/** attempts to get the full path for the given profile.
85
86		@param product
87			is the product name to get profile path.Currently support "Mozilla" and "Thunderbird".
88		@param profileName
89			the profile name to get full path.
90		@returns
91			the full path of the given profile.
92
93	 */
94	string getProfilePath( [in]MozillaProductType product,[in]string profileName);
95
96	/** attempts to get whether profile is locked by other applications.
97
98		@param product
99			is the product name to get profile path.Currently support "Mozilla" and "Thunderbird".
100		@param profileName
101			the profile name to check.
102		@returns
103			true is the given profile is locked.
104
105	 */
106	boolean isProfileLocked( [in]MozillaProductType product,[in]string profileName);
107
108	/** return true if the given profile exists
109
110		@param product
111			is the product name to get profile path.Currently support "Mozilla" and "Thunderbird".
112		@param profileName
113			the profile name to check.
114		@returns
115			whether given profile exists
116
117	 */
118	boolean getProfileExists( [in]MozillaProductType product,[in]string profileName);
119
120
121};
122
123//=============================================================================
124
125}; }; }; };
126
127#endif
128