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    package org.apache.directory.shared.ldap.exception;
021    
022    
023    import org.apache.directory.shared.ldap.message.ResultCodeEnum;
024    
025    
026    /**
027     * An interface for exceptions which add LDAP specific information to
028     * Exceptions.
029     * 
030     * @see <a
031     *      href="http://java.sun.com/j2se/1.4.2/docs/guide/jndi/jndi-ldap-gl.html#EXCEPT">
032     *      LDAP ResultCode to JNDI Exception Mappings</a>
033     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
034     * @version $Rev: 437007 $
035     */
036    public interface LdapException
037    {
038        /**
039         * Gets the LDAP result code that would be associated with this exception.
040         * 
041         * @return the LDAP result code corresponding to this exception type.
042         */
043        public ResultCodeEnum getResultCode();
044    }