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     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
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     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  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 2006-2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.types.operation;
028    
029    
030    
031    import org.opends.server.types.AttributeType;
032    import org.opends.server.types.ByteString;
033    import org.opends.server.types.DN;
034    import org.opends.server.types.Entry;
035    
036    
037    
038    /**
039     * This class defines a set of methods that are available for use by
040     * post-response plugins for compare operations.  Note that this
041     * interface is intended only to define an API for use by plugins and
042     * is not intended to be implemented by any custom classes.
043     */
044    @org.opends.server.types.PublicAPI(
045         stability=org.opends.server.types.StabilityLevel.UNCOMMITTED,
046         mayInstantiate=false,
047         mayExtend=false,
048         mayInvoke=true)
049    public interface PostResponseCompareOperation
050           extends PostResponseOperation
051    {
052      /**
053       * Retrieves the raw, unprocessed entry DN as included in the client
054       * request.
055       *
056       * @return  The raw, unprocessed entry DN as included in the client
057       *          request.
058       */
059      public ByteString getRawEntryDN();
060    
061    
062    
063      /**
064       * Retrieves the DN of the entry to compare.
065       *
066       * @return  The DN of the entry to compare.
067       */
068      public DN getEntryDN();
069    
070    
071    
072      /**
073       * Retrieves the raw attribute type for this compare operation.
074       *
075       * @return  The raw attribute type for this compare operation.
076       */
077      public String getRawAttributeType();
078    
079    
080    
081      /**
082       * Retrieves the attribute type for this compare operation.
083       *
084       * @return  The attribute type for this compare operation.
085       */
086      public AttributeType getAttributeType();
087    
088    
089    
090      /**
091       * Retrieves the assertion value for this compare operation.
092       *
093       * @return  The assertion value for this compare operation.
094       */
095      public ByteString getAssertionValue();
096    
097    
098    
099      /**
100       * Retrieves the entry to target with the compare operation.
101       *
102       * @return  The entry to target with the compare operation.
103       */
104      public Entry getEntryToCompare();
105    }
106