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
021package org.apache.directory.api.ldap.model.message;
022
023
024/**
025 * Intermediate response message used to return multiple response
026 * messages for a single search request (ExtendedRequest or Control).
027 * 
028 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
029 */
030public interface IntermediateResponse extends Response
031{
032    /** Intermediate response message type enumeration value */
033    MessageTypeEnum TYPE = MessageTypeEnum.INTERMEDIATE_RESPONSE;
034
035
036    /**
037     * Gets the response name
038     * 
039     * @return the ResponseName OID
040     */
041    String getResponseName();
042
043
044    /**
045     * Sets the response name.
046     * 
047     * @param oid the ResponseName
048     */
049    void setResponseName( String oid );
050
051
052    /**
053     * Gets the ResponseValue.
054     * 
055     * @return the responseValue
056     */
057    byte[] getResponseValue();
058
059
060    /**
061     * Sets the respponseValue
062     * 
063     * @param value The responseValue
064     */
065    void setResponseValue( byte[] value );
066}