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    
024    import org.apache.directory.shared.ldap.codec.MessageTypeEnum;
025    import org.apache.directory.shared.ldap.entry.Entry;
026    import org.apache.directory.shared.ldap.name.DN;
027    
028    
029    /**
030     * Search entry protocol response message used to return non referral entries to
031     * the client in response to a search request message.
032     * 
033     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
034     * @version $Revision: 918756 $
035     */
036    public interface InternalSearchResponseEntry extends InternalResponse
037    {
038        /** Search entry response message type enumeration value */
039        MessageTypeEnum TYPE = MessageTypeEnum.SEARCH_RESULT_ENTRY;
040    
041    
042        /**
043         * Gets the distinguished name of the entry object returned.
044         * 
045         * @return the Dn of the entry returned.
046         */
047        DN getObjectName();
048    
049    
050        /**
051         * Sets the distinguished name of the entry object returned.
052         * 
053         * @param dn the Dn of the entry returned.
054         */
055        void setObjectName( DN dn );
056    
057    
058        /**
059         * Gets the entry.
060         * 
061         * @return the entry
062         */
063        Entry getEntry();
064    
065    
066        /**
067         * Sets an entry
068         * 
069         * @param entry the entry
070         */
071        void setEntry( Entry entry );
072    }