/* -*- Mode: C++; tab-width: 2; 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 the mozilla.org LDAP XPCOM SDK.
 * 
 * The Initial Developer of the Original Code is
 * Peter Van der Beken.
 * Portions created by the Initial Developer are Copyright (C) 2002
 * Peter Van der Beken. All Rights Reserved.
 * 
 * Contributor(s):
 *   Peter Van der Beken <peterv@propagandism.org>
 *   Mark Banner <mark@standard8.demon.co.uk>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either 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 nsILDAPBERValue;
interface nsIArray;

[scriptable, uuid(f64ef501-0623-11d6-a7f2-b65476fc49dc)]
interface nsILDAPModification : nsISupports
{
  /**
   * The operation to perform.
   */
  attribute long operation;

  /**
   * Add operation
   */
  const long MOD_ADD = 0x00;

  /**
   * Delete operation
   */
  const long MOD_DELETE = 0x01;

  /**
   * Replace operation
   */
  const long MOD_REPLACE = 0x02;

  /**
   * Values are BER encoded
   */
  const long MOD_BVALUES = 0x80;

  /**
   * The attribute to modify.
   */
  attribute ACString type;

  /**
   * The array of values this modification sets for the attribute
   */
  attribute nsIArray values;

  /** 
   * Function that allows all the attributes to be set at the same
   * time to avoid multiple function calls.
   */
  void setUpModification(in long aOperation, in ACString aType,
                         in nsIArray aValues);

  void setUpModificationOneValue(in long aOperation, in ACString aType,
                                 in nsILDAPBERValue aValue);
};
