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-2023 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.common.operation;
028
029
030
031import com.unboundid.ldap.sdk.ReadOnlyCompareRequest;
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 interact with a
041 * compare request.
042 */
043@NotExtensible()
044@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
045public interface CompareRequest
046       extends Request
047{
048  /**
049   * Retrieves the DN of the entry to compare.
050   *
051   * @return  The DN of the entry to compare.
052   */
053  String getDN();
054
055
056
057  /**
058   * Retrieves the name or OID of the attribute to compare.
059   *
060   * @return  The name or OID of the attribute to compare.
061   */
062  String getAttributeType();
063
064
065
066  /**
067   * Retrieves the assertion value to compare against the values of the target
068   * attribute.
069   *
070   * @return  The assertion value to compare against the values of the target
071   *          attribute.
072   */
073  ByteString getAssertionValue();
074
075
076
077  /**
078   * Retrieves an LDAP SDK representation of this compare request.
079   *
080   * @return  An LDAP SDK representation of this compare request.
081   */
082  ReadOnlyCompareRequest toLDAPSDKRequest();
083}