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 * Add protocol operation request used to add a new entry to the DIT.
030 * 
031 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
032 */
033public interface AddRequest extends SingleReplyRequest, AbandonableRequest
034{
035    /**
036     * Gets the distinguished name of the entry to add.
037     * 
038     * @return the Dn of the added entry.
039     */
040    Dn getEntryDn();
041
042
043    /**
044     * Sets the distinguished name of the entry to add.
045     * 
046     * @param entry the Dn of the added entry.
047     * @return The AddRequest instance
048     */
049    AddRequest setEntryDn( Dn entry );
050
051
052    /**
053     * Gets the entry to add.
054     * 
055     * @return the added Entry
056     */
057    Entry getEntry();
058
059
060    /**
061     * Sets the Entry to add.
062     * 
063     * @param entry the added Entry
064     * @return The AddRequest instance
065     */
066    AddRequest setEntry( Entry entry );
067
068
069    /**
070     * {@inheritDoc}
071     */
072    @Override
073    AddRequest setMessageId( int messageId );
074
075
076    /**
077     * {@inheritDoc}
078     */
079    @Override
080    AddRequest addControl( Control control );
081
082
083    /**
084     * {@inheritDoc}
085     */
086    @Override
087    AddRequest addAllControls( Control[] controls );
088
089
090    /**
091     * {@inheritDoc}
092     */
093    @Override
094    AddRequest removeControl( Control control );
095}