/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 1999
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either of the GNU General Public License Version 2 or later (the "GPL"),
 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */


#include "nsISupports.idl"
#include "nsMsgSearchCore.idl"
#include "nsIMsgSearchScopeTerm.idl"

[ptr] native nsMsgResultElement(nsMsgResultElement);

%{C++
class nsMsgResultElement;
%}

[scriptable, uuid(B9F49D4C-A494-41f6-9D70-AB6CB5670485)]
interface nsIMsgSearchAdapter : nsISupports {
    void ValidateTerms();
    void Search(out boolean done);
    void SendUrl();
    void CurrentUrlDone(in long exitCode);

    void AddHit(in nsMsgKey key);
    void AddResultElement(in nsIMsgDBHdr aHdr);

    [noscript] void OpenResultElement(in nsMsgResultElement element);
    [noscript] void ModifyResultElement(in nsMsgResultElement element,
                                        in nsMsgSearchValue value);

    readonly attribute string encoding;
    
    [noscript] nsIMsgFolder FindTargetFolder([const] in nsMsgResultElement
                                             element);
    void Abort();
    void getSearchCharsets(out AString srcCharset, out AString destCharset);
    /*
     * Clear the saved scope reference. This is used when deleting scope, which is not
     * reference counted in nsMsgSearchSession
     */
    void clearScope();
};

