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.api.ldap.model.message;
022    
023    
024    /**
025     * Search reference protocol response message used to return referrals to the
026     * client in response to a search request message.
027     * 
028     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
029     */
030    public interface SearchResultReference extends Response
031    {
032        /** Search reference response message type enumeration value */
033        MessageTypeEnum TYPE = MessageTypeEnum.SEARCH_RESULT_REFERENCE;
034    
035    
036        /**
037         * Gets the sequence of LdapUrls as a Referral instance.
038         * 
039         * @return the sequence of LdapUrls
040         */
041        Referral getReferral();
042    
043    
044        /**
045         * Sets the sequence of LdapUrls as a Referral instance.
046         * 
047         * @param referral the sequence of LdapUrls
048         */
049        void setReferral( Referral referral );
050    }