using System;

using Framework.Services;

namespace Framework.Storage {
  
  /// <summary>Manages the save slots in which game states can be stored</summary>
  [
    ServiceScope(Scope.Global),
    DefaultBinding(typeof(SaveSlotManager))
  ]
  public interface ISaveSlotManager {

    /// <summary>Checks whether the slot with the specified index contains save data</summary>
    /// <param name="slotIndex">Index of the slot that will be checked</param>
    /// <returns>True if the specified save slot is filled</returns>
    bool IsSlotFilled(int slotIndex);

    /// <summary>Deletes the save slot with the specified index</summary>
    /// <param name="slotIndex">Index of the slot that will be deleted</param>
    void DeleteSaveSlot(int slotIndex);

    /// <summary>Returns the absolute path of the slot with the specified index</summary>
    /// <param name="slotIndex">Index of the slot whose path will be returned</param>
    /// <param name="create">Whether to create the slot if it doesn't exist yet</param>
    /// <returns>
    ///   The absolute path fo the slot with the specified index or null if the slot
    ///   does not exist and <paramref name="create" /> was set to false.   
    /// </returns>
    string GetSaveSlotPath(int slotIndex, bool create = false);

  }

} // namespace Framework.Storage