using System;
using System.Collections.Generic;

namespace Framework.Input {

  /// <summary>Collection of actions that can look up actions by name</summary>
  public interface IActionCollection : ICollection<IAction> {

    /// <summary>Looks up an action by its index</summary>
    /// <param name="index">Index of the action that will be accessed</param>
    /// <returns>The action at the specified index</returns>
    IAction this[int index] { get; }

    /// <summary>Looks up an action by its name</summary>
    /// <param name="actionName">Name of the action that will be looked up</param>
    /// <returns>The action with the specified name</returns>
    IAction this[string actionName] { get; }

    /// <summary>Tries to look up an action by its name</summary>
    /// <param name="actionName">Name of the action that will be looked up</param>
    /// <param name="action">Receives the action, if found</param>
    /// <returns>True if the action was found, false otherwise</returns>
    bool TryGet(string actionName, out IAction action);

    /// <summary>Removes an action by its name</summary>
    /// <param name="actionName">Name of the action that will be removed</param>
    /// <returns>True if an action with the specified name was found and removed</returns>
    bool Remove(string actionName);

    /// <summary>Checks whether the collection contains the specified action</summary>
    /// <param name="actionName">Action for which the collection will be checked</param>
    /// <returns>True if the collection contains an action with the specified name</returns>
    bool Contains(string actionName);

  }

} // namespace Framework.Input