Back to index

lightning-sunbird  0.9+nobinonly
nsIAbLDAPAttributeMap.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 20; indent-tabs-mode: nil; c-basic-offset: 2 -*-
00002  * 
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is mozilla addressbook code.
00017  *
00018  * The Initial Developer of the Original Code is Oracle Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 2005
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Dan Mosedale <dan.mosedale@oracle.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #include "nsISupports.idl"
00040 
00041 interface nsISimpleEnumerator;
00042 interface nsILDAPMessage;
00043 interface nsIAbCard;
00044 
00069 [scriptable, uuid(2ba46eae-9141-4d79-af90-3c7ecf2dc357)]
00070 interface nsIAbLDAPAttributeMap : nsISupports
00071 {
00081   ACString getAttributeList(in ACString aProperty);
00082 
00093   void getAttributes(in ACString aProperty, out unsigned long aCount,
00094                      [retval, array, size_is(aCount)] out string aAttrs);
00095 
00105   ACString getFirstAttribute(in ACString aProperty);
00106 
00125   void setAttributeList(in ACString aProperty, in ACString aAttributeList,
00126                         in boolean allowInconsistencies);
00127 
00134   ACString getProperty(in ACString aAttribute);
00135 
00145   ACString getAllCardAttributes();
00146 
00155   void checkState();
00156 
00157   /* These last two methods are really just for the convenience of the caller
00158    * and to avoid tons of unnecessary crossing of the XPConnect boundary.
00159    */
00160 
00172   void setFromPrefs(in ACString aPrefBranchName);
00173 
00184   void setCardPropertiesFromLDAPMessage(in nsILDAPMessage aMessage,
00185                                         in nsIAbCard aCard);
00186 };
00187 
00192 [scriptable, uuid(12e2d589-3c2a-48e4-8c82-b1e6464a0dfd)]
00193 interface nsIAbLDAPAttributeMapService : nsISupports
00194 {
00209   nsIAbLDAPAttributeMap getMapForPrefBranch(in ACString aPrefBranchName);
00210 };
00211 
00212 
00213 %{C++
00214 // test whether one of the getters has actually found an attribute
00215 #define ATTRMAP_FOUND_ATTR(rv, str) (NS_SUCCEEDED(rv) && !(str).IsEmpty())
00216 %}