Back to index

lightning-sunbird  0.9+nobinonly
nsIAbDirectoryQuery.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Sun Microsystems, Inc.
00019  * Portions created by the Initial Developer are Copyright (C) 2001
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Created by: Paul Sandoz   <paul.sandoz@sun.com>
00024  *   Dan Mosedale <dan.mosedale@oracle.com>
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either of the GNU General Public License Version 2 or later (the "GPL"),
00028  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 
00041 #include "nsISupports.idl"
00042 #include "nsISupportsArray.idl"
00043 #include "nsIAbBooleanExpression.idl"
00044 
00053 [scriptable, uuid(c2d83a31-eba6-4053-9273-c7a006a94311)]
00054 interface nsIAbDirectoryQueryArguments : nsISupports
00055 {
00061     attribute nsISupports expression;
00062 
00068     attribute boolean querySubDirectories;
00069 
00075     void setReturnProperties (in unsigned long returnPropertiesSize,
00076         [array, size_is(returnPropertiesSize)]
00077         in string returnPropertiesArray);
00078     void getReturnProperties (out unsigned long returnPropertiesSize,
00079         [retval, array, size_is(returnPropertiesSize)]
00080         out string returnPropertiesArray);
00081 
00086     attribute nsISupports typeSpecificArg;
00087 };
00088 
00089 
00090 [scriptable, uuid(3A6E0C0C-1DD2-11B2-B23D-EA3A8CCB333C)]
00091 interface nsIAbDirectoryQueryPropertyValue : nsISupports
00092 {
00106     readonly attribute string name;
00107 
00112     readonly attribute wstring value;
00113     
00123     readonly attribute nsISupports valueISupports;
00124 };
00125 
00126 [scriptable, uuid(42E600BA-1DD2-11B2-BC39-C363AC0C93E3)]
00127 interface nsIAbDirectoryQueryResult : nsISupports
00128 {
00133     readonly attribute long contextID;
00134 
00141     readonly attribute nsIAbDirectoryQueryArguments contextArgs;
00142 
00147     const long queryResultMatch     = 0;
00148     const long queryResultComplete     = 1;
00149     const long queryResultStopped     = 2;
00150     const long queryResultError     = 3;
00151 
00158     readonly attribute long type;
00159 
00173     readonly attribute nsISupportsArray result;
00174 
00180     void agetResult (out unsigned long aResultSize,
00181         [retval, array, size_is(aResultSize)]
00182         out nsISupports aResultArray);
00183 };
00184 
00185 [scriptable, uuid(4290E508-1DD2-11B2-AC3E-9597BBCB25D7)]
00186 interface nsIAbDirectoryQueryResultListener : nsISupports
00187 {
00197     void onQueryItem (in nsIAbDirectoryQueryResult result);
00198 };
00199 
00200 [scriptable, uuid(4241C46E-1DD2-11B2-978D-A2FBD0A72AC2)]
00201 interface nsIAbDirectoryQuery : nsISupports
00202 {
00222     long doQuery (in nsIAbDirectoryQueryArguments arguments,
00223         in nsIAbDirectoryQueryResultListener listener,
00224         in long resultLimit,
00225         in long timeOut);
00226 
00242     void stopQuery (in long contextID);
00243 };
00244 
00245