summaryrefslogtreecommitdiffstats
path: root/comm/mailnews/addrbook/public/nsILDAPModification.idl
blob: 453efc4aaadfa10cba0f79b44679da5a747a4c83 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsISupports.idl"

interface nsILDAPBERValue;

[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 Array<nsILDAPBERValue> 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 Array<nsILDAPBERValue> aValues);

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