using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Tango.MachineStudio.Common.Navigation
{
    /// <summary>
    /// Represents a object which provides a result the navigation system navigates away from it.
    /// </summary>
    /// <typeparam name="TResult">The type of the result.</typeparam>
    /// <typeparam name="TPass">The type of the pass.</typeparam>
    public interface INavigationResultProvider<TResult, TPass>
    {
        /// <summary>
        /// Called when the navigation system requests a result when it is navigating away from this instance.
        /// </summary>
        /// <returns></returns>
        TResult GetNavigationResult();

        /// <summary>
        /// Called when navigation system is going to navigate to this instance with the specified object.
        /// </summary>
        /// <param name="obj">The object.</param>
        void OnNavigationObjectReceived(TPass obj);
    }
}