﻿// 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.

using System;
using Org.Apache.REEF.Utilities;

namespace Org.Apache.REEF.Common.Api
{
    /// <summary>
    /// Common interface for all error messages in REEF.
    /// Most of its functionality is generic and implemented in the AbstractFailure class.
    /// </summary>
    public interface IFailure : IIdentifiable
    {
        /// <summary>
        /// One-line error message. Should never be null.
        /// </summary>
        string Message { get; set; }

        /// <summary>
        ///  Optional long error description.
        /// </summary>
        Optional<string> Description { get; set; }

        /// <summary>
        /// Exception that caused the error, or null.
        /// </summary>
        Optional<string> Reason { get; set; }

        /// <summary>
        /// Optional serialized version of the error message.
        /// </summary>
        Optional<byte[]> Data { get; set; }

        /// <summary>
        /// Return the original Java Exception, or generate a new one if it does not exists.
        /// ALWAYS returns an exception, never null
        /// </summary>
        Exception AsError();
    }
}