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.ByteString; 032 033 034 035 /** 036 * This class defines a set of methods that are available for use by 037 * pre-parse plugins for compare operations. Note that this interface 038 * is intended only to define an API for use by plugins and is not 039 * intended to be implemented by any custom classes. 040 */ 041 @org.opends.server.types.PublicAPI( 042 stability=org.opends.server.types.StabilityLevel.UNCOMMITTED, 043 mayInstantiate=false, 044 mayExtend=false, 045 mayInvoke=true) 046 public interface PreParseCompareOperation 047 extends PreParseOperation 048 { 049 /** 050 * Retrieves the raw, unprocessed entry DN as included in the client 051 * request. 052 * 053 * @return The raw, unprocessed entry DN as included in the client 054 * request. 055 */ 056 public ByteString getRawEntryDN(); 057 058 059 060 /** 061 * Specifies the raw, unprocessed entry DN as included in the client 062 * request. 063 * 064 * @param rawEntryDN The raw entry DN for this compare operation. 065 */ 066 public void setRawEntryDN(ByteString rawEntryDN); 067 068 069 070 /** 071 * Retrieves the raw attribute type for this compare operation. 072 * 073 * @return The raw attribute type for this compare operation. 074 */ 075 public String getRawAttributeType(); 076 077 078 079 /** 080 * Specifies the raw attribute type for this compare operation. 081 * 082 * @param rawAttributeType The raw attribute type for this compare 083 * operation. 084 */ 085 public void setRawAttributeType(String rawAttributeType); 086 087 088 089 /** 090 * Retrieves the assertion value for this compare operation. 091 * 092 * @return The assertion value for this compare operation. 093 */ 094 public ByteString getAssertionValue(); 095 096 097 098 /** 099 * Specifies the assertion value for this compare operation. 100 * 101 * @param assertionValue The assertion value for this compare 102 * operation. 103 */ 104 public void setAssertionValue(ByteString assertionValue); 105 } 106