001    /*
002     * Copyright 2007-2014 UnboundID Corp.
003     * All Rights Reserved.
004     */
005    /*
006     * Copyright (C) 2008-2014 UnboundID Corp.
007     *
008     * This program is free software; you can redistribute it and/or modify
009     * it under the terms of the GNU General Public License (GPLv2 only)
010     * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
011     * as published by the Free Software Foundation.
012     *
013     * This program is distributed in the hope that it will be useful,
014     * but WITHOUT ANY WARRANTY; without even the implied warranty of
015     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
016     * GNU General Public License for more details.
017     *
018     * You should have received a copy of the GNU General Public License
019     * along with this program; if not, see <http://www.gnu.org/licenses>.
020     */
021    package com.unboundid.ldap.sdk;
022    
023    
024    
025    import com.unboundid.ldif.LDIFDeleteChangeRecord;
026    
027    
028    
029    /**
030     * This interface defines a set of methods that may be safely called in an LDAP
031     * delete request without altering its contents.  This interface must not be
032     * implemented by any class other than {@code DeleteRequest}.
033     * <BR><BR>
034     * This interface does not inherently provide the assurance of thread safety for
035     * the methods that it exposes, because it is still possible for a thread
036     * referencing the object which implements this interface to alter the request
037     * using methods not included in this interface.  However, if it can be
038     * guaranteed that no thread will alter the underlying object, then the methods
039     * exposed by this interface can be safely invoked concurrently by any number of
040     * threads.
041     */
042    public interface ReadOnlyDeleteRequest
043           extends ReadOnlyLDAPRequest
044    {
045      /**
046       * Retrieves the DN of the entry to delete.
047       *
048       * @return  The DN of the entry to delete.
049       */
050      String getDN();
051    
052    
053    
054      /**
055       * {@inheritDoc}
056       */
057      DeleteRequest duplicate();
058    
059    
060    
061      /**
062       * {@inheritDoc}
063       */
064      DeleteRequest duplicate(final Control[] controls);
065    
066    
067    
068      /**
069       * Retrieves an LDIF delete change record with the contents of this delete
070       * request.
071       *
072       * @return  An LDIF delete change record with the contents of this delete
073       *          request.
074       */
075      LDIFDeleteChangeRecord toLDIFChangeRecord();
076    
077    
078    
079      /**
080       * Retrieves a string array whose lines contain an LDIF representation of the
081       * corresponding delete change record.
082       *
083       * @return  A string array whose lines contain an LDIF representation of the
084       *          corresponding delete change record.
085       */
086      String[] toLDIF();
087    
088    
089    
090      /**
091       * Retrieves an LDIF string representation of this delete request.
092       *
093       * @return  An LDIF string representation of this delete request.
094       */
095      String toLDIFString();
096    }