001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at
010 * docs/licenses/cddl.txt
011 * or http://www.opensource.org/licenses/cddl1.php.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * docs/licenses/cddl.txt.  If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 *      Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 *      Copyright 2010-2017 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.common.operation;
028
029
030
031import com.unboundid.directory.sdk.common.types.Entry;
032import com.unboundid.ldap.sdk.ReadOnlyAddRequest;
033import com.unboundid.ldif.LDIFAddChangeRecord;
034import com.unboundid.util.NotExtensible;
035import com.unboundid.util.ThreadSafety;
036import com.unboundid.util.ThreadSafetyLevel;
037
038
039
040/**
041 * This interface defines a set of methods which may be used to interact with an
042 * add request.
043 */
044@NotExtensible()
045@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
046public interface AddRequest
047       extends ChangeRequest
048{
049  /**
050   * Retrieves the entry to be added.
051   *
052   * @return  The entry to be added.
053   */
054  Entry getEntry();
055
056
057
058  /**
059   * Retrieves an LDAP SDK representation of this add request.
060   *
061   * @return  An LDAP SDK representation of this add request.
062   */
063  ReadOnlyAddRequest toLDAPSDKRequest();
064
065
066
067  /**
068   * Retrieves an LDIF change record that corresponds to this add request.
069   *
070   * @return  An LDIF change record that corresponds to this add request.
071   */
072  LDIFAddChangeRecord toLDIFChangeRecord();
073
074
075
076  /**
077   * Indicates whether this {@code AddRequest} contains the {@code
078   * UndeleteRequestControl}. If this method returns {@code true}, the
079   * undelete control can be obtained from the {@link #getRequestControls()}
080   * method.
081   *
082   * @return true if the {@code UndeleteRequestControl} is included in this
083   *              request, false if not.
084   */
085  boolean isUndelete();
086}