View Javadoc
1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *  
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *  
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License. 
18   *  
19   */
20  
21  package org.apache.directory.api.ldap.model.message;
22  
23  
24  /**
25   * Intermediate response message used to return multiple response
26   * messages for a single search request (ExtendedRequest or Control).
27   * 
28   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
29   */
30  public interface IntermediateResponse extends Response
31  {
32      /** Intermediate response message type enumeration value */
33      MessageTypeEnum TYPE = MessageTypeEnum.INTERMEDIATE_RESPONSE;
34  
35  
36      /**
37       * Gets the response name
38       * 
39       * @return the ResponseName OID
40       */
41      String getResponseName();
42  
43  
44      /**
45       * Sets the response name.
46       * 
47       * @param oid the ResponseName
48       */
49      void setResponseName( String oid );
50  
51  
52      /**
53       * Gets the ResponseValue.
54       * 
55       * @return the responseValue
56       */
57      byte[] getResponseValue();
58  
59  
60      /**
61       * Sets the respponseValue
62       * 
63       * @param value The responseValue
64       */
65      void setResponseValue( byte[] value );
66  }