001 /* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 * 019 */ 020 021 package org.apache.directory.shared.ldap.message.internal; 022 023 import org.apache.directory.shared.ldap.codec.MessageTypeEnum; 024 025 026 /** 027 * Intermediate response message used to return multiple response 028 * messages for a single search request (ExtendedRequest or Control). 029 * 030 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 031 * @version $Revision: 905344 $ 032 */ 033 public interface InternalIntermediateResponse extends InternalResponse 034 { 035 /** Intermediate response message type enumeration value */ 036 MessageTypeEnum TYPE = MessageTypeEnum.INTERMEDIATE_RESPONSE; 037 038 039 /** 040 * Gets the response name 041 * 042 * @return the ResponseName OID 043 */ 044 String getResponseName(); 045 046 047 /** 048 * Sets the response name. 049 * 050 * @param oid the ResponseName 051 */ 052 void setResponseName( String oid ); 053 054 055 /** 056 * Gets the ResponseValue. 057 * 058 * @return the responseValue 059 */ 060 byte[] getResponseValue(); 061 062 063 /** 064 * Sets the respponseValue 065 * 066 * @param value The responseValue 067 */ 068 void setResponseValue( byte[] value ); 069 }