001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2006-2008 Sun Microsystems, Inc.
015 * Portions Copyright 2014-2015 ForgeRock AS.
016 */
017package org.opends.server.types.operation;
018
019
020
021import org.forgerock.opendj.ldap.ByteString;
022
023
024/**
025 * This class defines a set of methods that are available for use by
026 * pre-parse plugins for compare operations.  Note that this interface
027 * is intended only to define an API for use by plugins and is not
028 * intended to be implemented by any custom classes.
029 */
030@org.opends.server.types.PublicAPI(
031     stability=org.opends.server.types.StabilityLevel.UNCOMMITTED,
032     mayInstantiate=false,
033     mayExtend=false,
034     mayInvoke=true)
035public interface PreParseCompareOperation
036       extends PreParseOperation
037{
038  /**
039   * Retrieves the raw, unprocessed entry DN as included in the client
040   * request.
041   *
042   * @return  The raw, unprocessed entry DN as included in the client
043   *          request.
044   */
045  ByteString getRawEntryDN();
046
047
048
049  /**
050   * Specifies the raw, unprocessed entry DN as included in the client
051   * request.
052   *
053   * @param  rawEntryDN  The raw entry DN for this compare operation.
054   */
055  void setRawEntryDN(ByteString rawEntryDN);
056
057
058
059  /**
060   * Retrieves the raw attribute type for this compare operation.
061   *
062   * @return  The raw attribute type for this compare operation.
063   */
064  String getRawAttributeType();
065
066
067
068  /**
069   * Specifies the raw attribute type for this compare operation.
070   *
071   * @param  rawAttributeType  The raw attribute type for this compare
072   *                           operation.
073   */
074  void setRawAttributeType(String rawAttributeType);
075
076
077
078  /**
079   * Retrieves the assertion value for this compare operation.
080   *
081   * @return  The assertion value for this compare operation.
082   */
083  ByteString getAssertionValue();
084
085
086
087  /**
088   * Specifies the assertion value for this compare operation.
089   *
090   * @param  assertionValue  The assertion value for this compare
091   *                         operation.
092   */
093  void setAssertionValue(ByteString assertionValue);
094}
095