1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /* ***** BEGIN LICENSE BLOCK *****
3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4 *
5 * The contents of this file are subject to the Mozilla Public License Version
6 * 1.1 (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 * http://www.mozilla.org/MPL/
9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
13 * License.
14 *
15 * The Original Code is mozilla.org code.
16 *
17 * The Initial Developer of the Original Code is
18 * Sun Microsystems, Inc.
19 * Portions created by the Initial Developer are Copyright (C) 2001
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 * Created by: Paul Sandoz <paul.sandoz@sun.com>
24 *
25 * Alternatively, the contents of this file may be used under the terms of
26 * either of the GNU General Public License Version 2 or later (the "GPL"),
27 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
28 * in which case the provisions of the GPL or the LGPL are applicable instead
29 * of those above. If you wish to allow use of your version of this file only
30 * under the terms of either the GPL or the LGPL, and not to allow others to
31 * use your version of this file under the terms of the MPL, indicate your
32 * decision by deleting the provisions above and replace them with the notice
33 * and other provisions required by the GPL or the LGPL. If you do not delete
34 * the provisions above, a recipient may use your version of this file under
35 * the terms of any one of the MPL, the GPL or the LGPL.
36 *
37 * ***** END LICENSE BLOCK ***** */
38
39
40 #include "nsISupports.idl"
41
42 /**
43 * Searching of cards on a directory.
44 *
45 * The search data is defined in the query
46 * section of the directory URI, for example
47 *
48 * moz-abldapdirectory://ldap1.holland/dc=sun,dc=com?<query>
49 *
50 * If no search data is defined then the methods
51 * will return immediately with no error.
52 */
53 [scriptable, uuid(ABF26047-37E3-44FD-A28A-6D37A1B9CCB3)]
54 interface nsIAbDirectorySearch : nsISupports
55 {
56 /**
57 * Starts a search on the directory.
58 *
59 * If a search is already being performed
60 * it is stopped.
61 *
62 * The results from a search, cards, will
63 * returned by informing the address book
64 * session that a new card has been added
65 * to the directory.
66 *
67 * The nsIAbDirectoryQuery implementation
68 * of the directory component (or a proxy)
69 * may be used as an implementation for
70 * this specialization of query.
71 *
72 * This method is semantically equivalent
73 * to the nsIAbDirectory.getChildCards
74 * method when there is search criteria
75 * defined in the directory uri.
76 *
77 */
78 void startSearch ();
79
80 /**
81 * Stops a search on the directory.
82 *
83 */
84 void stopSearch ();
85 };