View Javadoc

1   /*
2    * Copyright 2002-2005 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package net.sf.ldaptemplate.support;
18  
19  import javax.naming.directory.ModificationItem;
20  
21  /***
22   * Indicates that the implementor is capable of keeping track of any attribute
23   * modifications and return them as ModificationItems.
24   * 
25   * @author Mattias Arthursson
26   * 
27   */
28  public interface AttributeModificationsAware {
29  
30      /***
31       * Creates an array of which attributes have been changed or added. Note:
32       * Does not create a modification item if one attribute has been removed. If
33       * not in update mode, it will always return an empty array.
34       * 
35       * @return an array of modification items
36       */
37      public ModificationItem[] getModificationItems();
38  }