RetroZilla/xpfe/components/autocomplete/public/nsILDAPAutoCompFormatter.idl

109 lines
4.4 KiB
Plaintext
Raw Normal View History

2015-10-21 05:03:22 +02:00
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*
* ***** 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) 2001
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Dan Mosedale <dmose@netscape.com> (Original Author)
*
* 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"
interface nsIAutoCompleteItem;
interface nsILDAPMessage;
/**
* An interface to allow different users of nsILDAPAutoCompleteSession to
* format each nsILDAPMessage into an nsIAutoCompleteItem as it sees fit.
*/
[scriptable, uuid(cbec617c-22d2-4286-8308-0ef8bf57c0ce)]
interface nsILDAPAutoCompFormatter : nsISupports {
/**
* Returns an nsIAutoCompleteItem generated from the data in
* the given nsILDAPMessage.
*
* @param aMessage message to be formatted
* @return resulting nsIAutoCompleteItem
*/
nsIAutoCompleteItem format(in nsILDAPMessage aMessage);
/**
* Gets a list of all the LDAP attributes that should be requested
* from the LDAP server when a lookup is done. This avoids
* wasting server time, bandwidth, and client time processing
* unused attributes.
*
* Note that this is only required to be called by the
* nsILDAPAutoCompleteSession implementation when the
* nsILDAPAutoCompleteSession::formatter IDL attribute is set. .
* So if for some reason, the LDAP attributes to be returned by
* searches has to change (eg because the user changed a
* preference), the nsILDAPAutoCompleteSession::formatter IDL
* attribute should be re-set to the same object to force a new
* getAttributes() call.
*
* @param aCount number of attributes in the array
* @param aAttrs list of LDAP attributes to request
*/
void getAttributes(out unsigned long aCount,
[retval, array, size_is(aCount)] out string aAttrs);
/**
* This method formats an error condition into an nsIAutoCompleteItem
* for display to the user. Specifically, the state that the session
* was in when the error occured (aState) is formatted into a general
* error message which is put in the value attribute of the item,
* and the specific error (aErrorCode) is formatted into another message
* which is put in an nsISupportsString in the param attribute of the
* item.
*
* @param aState state of autocomplete session when error occurred
* @param aErrorCode specific error encountered
*
* @return newly generated item
*/
nsIAutoCompleteItem formatException(in long aState,
in nsresult aErrorCode);
/**
* Possible states that can be passed in aState to formatException
*/
const long STATE_UNBOUND = 0;
const long STATE_INITIALIZING = 1;
const long STATE_BINDING = 2;
const long STATE_BOUND = 3;
const long STATE_SEARCHING = 4;
};