/extensions/pref/autoconfig/public/nsILDAPSyncQuery.idl

 1/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 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 * Netscape Communications Corporation.
19 * Portions created by the Initial Developer are Copyright (C) 1998
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 *   Mitesh Shah <mitesh@netscape.com>
24 *   Dan Mosedale <dmose@mozilla.org>
25 *
26 * Alternatively, the contents of this file may be used under the terms of
27 * either the GNU General Public License Version 2 or later (the "GPL"), or
28 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
29 * in which case the provisions of the GPL or the LGPL are applicable instead
30 * of those above. If you wish to allow use of your version of this file only
31 * under the terms of either the GPL or the LGPL, and not to allow others to
32 * use your version of this file under the terms of the MPL, indicate your
33 * decision by deleting the provisions above and replace them with the notice
34 * and other provisions required by the GPL or the LGPL. If you do not delete
35 * the provisions above, a recipient may use your version of this file under
36 * the terms of any one of the MPL, the GPL or the LGPL.
37 *
38 * ***** END LICENSE BLOCK ***** */
39
40#include "nsISupports.idl"
41interface nsILDAPURL;
42
43
44[scriptable, uuid (0308fb36-1dd2-11b2-b16f-8510e8c5311a)]
45interface nsILDAPSyncQuery : nsISupports {
46  
47  /**
48   * getQueryResults
49   *
50   * Create a new LDAP connection do a synchronous LDAP search and return 
51   * the results.
52   * @param aServerURL - LDAP URL with parameters to a LDAP search 
53   *                     ("ldap://host/base?attributes?one/sub?filter")
54   * @param aProtocolVersion - LDAP protocol version to use for connection
55   *                           (nsILDAPConnection.idl has symbolic constants)
56   * @return results
57   */
58   wstring getQueryResults (in nsILDAPURL aServerURL,
59                            in unsigned long aProtocolVersion);
60
61};