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 *      Portions Copyright 2010-2024 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.common.operation;
028
029
030
031import com.unboundid.ldap.sdk.DN;
032import com.unboundid.util.ByteString;
033import com.unboundid.util.NotExtensible;
034import com.unboundid.util.ThreadSafety;
035import com.unboundid.util.ThreadSafetyLevel;
036
037
038
039/**
040 * This interface defines a set of methods which may be used to update a compare
041 * request.
042 */
043@NotExtensible()
044@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
045public interface UpdatableCompareRequest
046       extends CompareRequest, UpdatableRequest
047{
048  /**
049   * Specifies the DN of the entry to compare.
050   *
051   * @param  dn  The DN of the entry to compare.  It must not be {@code null}.
052   */
053  void setDN(final String dn);
054
055
056
057  /**
058   * Specifies the DN of the entry to compare.
059   *
060   * @param  dn  The DN of the entry to compare.  It must not be {@code null}.
061   */
062  void setDN(final DN dn);
063
064
065
066  /**
067   * Specifies the name or OID of the attribute to compare.
068   *
069   * @param  attributeType  The name or OID of the attribute to compare.  It
070   *                        must not be {@code null}.
071   */
072  void setAttributeType(final String attributeType);
073
074
075
076  /**
077   * Specifies the assertion value to compare against the values of the target
078   * attribute.
079   *
080   * @param  assertionValue  The assertion value to compare against the values
081   *                         of the target attribute.  It must not be
082   *                         {@code null}.
083   */
084  void setAssertionValue(final ByteString assertionValue);
085}