mailnews/addrbook/public/nsIAbDirectorySearch.idl
author Jorg K
Mon, 18 Dec 2017 23:37:21 +0100
changeset 57423 12a18e736fca9a9ac8e0866caf470fa9342af842
parent 12009 84ac3c71109811da751f0ef2d72108075938f094
child 80405 1edda72532b435446b2a07bcb54f62039ebf506d
permissions -rw-r--r--
Bug 1399756 - remove trailing spaces from IDL files in mailnews. rs=white-space-only

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* 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/. */


#include "nsISupports.idl"

/**
 * Searching of cards on a directory.
 *
 * The search data is defined in the query
 * section of the directory URI, for example
 *
 * moz-abldapdirectory://ldap1.holland/dc=sun,dc=com?<query>
 *
 * If no search data is defined then the methods
 * will return immediately with no error.
 */
[scriptable, uuid(ABF26047-37E3-44FD-A28A-6D37A1B9CCB3)]
interface nsIAbDirectorySearch : nsISupports
{
    /**
     * Starts a search on the directory.
     *
     * If a search is already being performed
     * it is stopped.
     *
     * The results from a search, cards, will
     * returned by informing the address book
     * session that a new card has been added
     * to the directory.
     *
     * The nsIAbDirectoryQuery implementation
     * of the directory component (or a proxy)
     * may be used as an implementation for
     * this specialization of query.
     *
     * This method is semantically equivalent
     * to the nsIAbDirectory.getChildCards
     * method when there is search criteria
     * defined in the directory uri.
     *
     */
    void startSearch ();

    /**
     * Stops a search on the directory.
     *
     */
    void stopSearch ();
};