001    /*
002     * CDDL HEADER START
003     *
004     * The contents of this file are subject to the terms of the
005     * Common Development and Distribution License, Version 1.0 only
006     * (the "License").  You may not use this file except in compliance
007     * with the License.
008     *
009     * You can obtain a copy of the license at
010     * docs/licenses/cddl.txt
011     * or http://www.opensource.org/licenses/cddl1.php.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * docs/licenses/cddl.txt.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2010-2012 UnboundID Corp.
026     */
027    package com.unboundid.directory.sdk.common.operation;
028    
029    
030    
031    import java.util.List;
032    
033    import com.unboundid.ldap.sdk.Modification;
034    import com.unboundid.ldap.sdk.ReadOnlyModifyRequest;
035    import com.unboundid.ldif.LDIFModifyChangeRecord;
036    import com.unboundid.util.NotExtensible;
037    import com.unboundid.util.ThreadSafety;
038    import com.unboundid.util.ThreadSafetyLevel;
039    
040    
041    
042    /**
043     * This interface defines a set of methods which may be used to interact with a
044     * modify request.
045     */
046    @NotExtensible()
047    @ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
048    public interface ModifyRequest
049           extends ChangeRequest
050    {
051      /**
052       * Retrieves the DN of the entry to modify.
053       *
054       * @return  The DN of the entry to modify.
055       */
056      String getDN();
057    
058    
059    
060      /**
061       * Retrieves the modifications to be applied.
062       *
063       * @return  The modifications to be applied.
064       */
065      List<Modification> getModifications();
066    
067    
068    
069      /**
070       * Retrieves an LDAP SDK representation of this modify request.
071       *
072       * @return  An LDAP SDK representation of this modify request.
073       */
074      ReadOnlyModifyRequest toLDAPSDKRequest();
075    
076    
077    
078      /**
079       * Retrieves an LDIF change record that corresponds to this modify request.
080       *
081       * @return  An LDIF change record that corresponds to this modify request.
082       */
083      LDIFModifyChangeRecord toLDIFChangeRecord();
084    }