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