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-2020 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.common.operation;
028
029
030
031import com.unboundid.directory.sdk.common.types.AssuredReplicationRequirements;
032import com.unboundid.directory.sdk.common.types.Entry;
033import com.unboundid.util.NotExtensible;
034import com.unboundid.util.ThreadSafety;
035import com.unboundid.util.ThreadSafetyLevel;
036
037
038
039/**
040 * This interface defines a set of methods which may be used to interact with
041 * delete results.
042 */
043@NotExtensible()
044@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
045public interface DeleteResult
046       extends GenericResult
047{
048  /**
049   * Retrieves the entry against which the delete operation was processed, if
050   * available.  This may be available for both hard and soft deletes.
051   *
052   * @return  The entry against which the delete operation was processed, or
053   *          {@code null} if the entry is not available.
054   */
055  Entry getDeletedEntry();
056
057
058
059  /**
060   * Retrieves the soft-deleted entry if this {@code DeleteResult} is in
061   * response to a soft-delete request.
062   *
063   * @return  The soft-deleted entry, or {@code null} if the original request
064   *          was not a soft delete request or the entry is not available.
065   */
066  Entry getSoftDeletedEntry();
067
068
069
070  /**
071   * Retrieves the assured replication requirements that will be used for this
072   * operation, if any.
073   *
074   * @return  The assured replication requirements that will be used for this
075   *          operation, or {@code null} if no assurance will be provided for
076   *          this operation.
077   */
078  AssuredReplicationRequirements getAssuredReplicationRequirements();
079}