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-2013 UnboundID Corp.
026     */
027    package com.unboundid.directory.sdk.common.operation;
028    
029    
030    import com.unboundid.directory.sdk.common.types.Entry;
031    import com.unboundid.util.NotExtensible;
032    import com.unboundid.util.ThreadSafety;
033    import com.unboundid.util.ThreadSafetyLevel;
034    
035    
036    
037    /**
038     * This interface defines a set of methods which may be used to interact with
039     * delete results.
040     */
041    @NotExtensible()
042    @ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
043    public interface DeleteResult
044           extends GenericResult
045    {
046      /**
047       * Retrieves the entry against which the delete operation was processed, if
048       * available.  This may be available for both hard and soft deletes.
049       *
050       * @return  The entry against which the delete operation was processed, or
051       *          {@code null} if the entry is not available.
052       */
053      Entry getDeletedEntry();
054    
055    
056    
057      /**
058       * Retrieves the soft-deleted entry if this {@code DeleteResult} is in
059       * response to a soft-delete request.
060       *
061       * @return  The soft-deleted entry, or {@code null} if the original request
062       *          was not a soft delete request or the entry is not available.
063       */
064      Entry getSoftDeletedEntry();
065    }