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
021package org.apache.directory.api.ldap.model.message;
022
023
024import org.apache.directory.api.ldap.model.entry.Entry;
025import org.apache.directory.api.ldap.model.name.Dn;
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 */
034public interface SearchResultEntry extends Response
035{
036    /** Search entry response message type enumeration value */
037    MessageTypeEnum TYPE = MessageTypeEnum.SEARCH_RESULT_ENTRY;
038
039
040    /**
041     * Gets the distinguished name of the entry object returned.
042     * 
043     * @return the Dn of the entry returned.
044     */
045    Dn getObjectName();
046
047
048    /**
049     * Sets the distinguished name of the entry object returned.
050     * 
051     * @param objectName the Dn of the entry returned.
052     */
053    void setObjectName( Dn objectName );
054
055
056    /**
057     * Gets the entry.
058     * 
059     * @return the entry
060     */
061    Entry getEntry();
062
063
064    /**
065     * Sets an entry
066     * 
067     * @param entry the entry
068     */
069    void setEntry( Entry entry );
070}