/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.olingo.server.api;

/**
 * The WriteContentErrorErrorContext is the parameter for the WriteContentErrorCallback.
 * and contains all relevant error information
 */
public interface ODataContentWriteErrorContext {
  /**
   * Get the exception which caused this error (as Java exception).
   * If the cause exception is a ODataLibraryException this method will
   * return the same exception as the {@link #getODataLibraryException()} method.
   *
   * @return the exception which caused this error (as Java exception).
   */
  Exception getException();
  /**
   * Get the exception which caused this error (as ODataLibraryException exception).
   * If the cause exception is an ODataLibraryException this method will
   * return the same exception as the {@link #getException()} method.
   * If the cause exception is <b>NOT</b> an ODataLibraryException this method will
   * return <code>NULL</code>.
   *
   * @return the cause exception if it is an ODataLibraryException otherwise
   *          this method will return <code>NULL</code>.
   */
  ODataLibraryException getODataLibraryException();
}
