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-2018 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.common.operation;
028
029
030
031import java.util.List;
032
033import com.unboundid.ldap.sdk.DN;
034import com.unboundid.ldap.sdk.Modification;
035import com.unboundid.util.NotExtensible;
036import com.unboundid.util.ThreadSafety;
037import com.unboundid.util.ThreadSafetyLevel;
038
039
040
041/**
042 * This interface defines a set of methods which may be used to update a modify
043 * request.
044 */
045@NotExtensible()
046@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
047public interface UpdatableModifyRequest
048       extends ModifyRequest, UpdatableRequest
049{
050  /**
051   * Specifies the DN of the entry to modify.
052   *
053   * @param  dn  The DN of the entry to modify.  It must not be {@code null}.
054   */
055  void setDN(final String dn);
056
057
058
059  /**
060   * Specifies the DN of the entry to modify.
061   *
062   * @param  dn  The DN of the entry to modify.  It must not be {@code null}.
063   */
064  void setDN(final DN dn);
065
066
067
068  /**
069   * Specifies the modifications to be applied.
070   *
071   * @param  modifications  The modifications to be applied.  It must not be
072   *                        {@code null}.
073   */
074  void setModifications(final List<Modification> modifications);
075}