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 * Search reference protocol response message used to return referrals to the
26 * client in response to a search request message.
27 *
28 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
29 */
30 public interface SearchResultReference extends Response
31 {
32 /**
33 * Gets the sequence of LdapUrls as a Referral instance.
34 *
35 * @return the sequence of LdapUrls
36 */
37 Referral getReferral();
38
39
40 /**
41 * Sets the sequence of LdapUrls as a Referral instance.
42 *
43 * @param referral the sequence of LdapUrls
44 */
45 void setReferral( Referral referral );
46 }