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

namespace Tango.DataStore
{
    /// <summary>
    /// Represents a data store collection.
    /// </summary>
    public interface IDataStoreCollection
    {
        /// <summary>
        /// Gets the collection name.
        /// </summary>
        String Name { get; }

        /// <summary>
        /// Upserts the specified key and value.
        /// </summary>
        /// <param name="key">The key.</param>
        /// <param name="value">The value.</param>
        void Put(String key, Object value);

        /// <summary>
        /// Upserts the specified key and value of type T.
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="key">The key.</param>
        /// <param name="value">The value.</param>
        void Put<T>(String key, T value);

        /// <summary>
        /// Upserts the specified key and value.
        /// The value must be of the specified DataType.
        /// </summary>
        /// <param name="key">The key.</param>
        /// <param name="type">The type.</param>
        /// <param name="value">The value.</param>
        void Put(String key, DataType type, Object value);

        /// <summary>
        /// Gets the value by the specified key
        /// </summary>
        /// <param name="key">The key.</param>
        /// <returns></returns>
        Object Get(String key);

        /// <summary>
        /// Gets the value by the specified key
        /// </summary>
        /// <param name="key">The key.</param>
        /// <param name="defaultValue">Will execute put when the key was not found.</param>
        /// <returns></returns>
        Object Get(String key, Object defaultValue);

        /// <summary>
        /// Gets the value of type T by the specified key
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="key">The key.</param>
        /// <returns></returns>
        T Get<T>(String key);

        /// <summary>
        /// Gets the value of type T by the specified key
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="key">The key.</param>
        /// <param name="defaultValue">Will execute put when the key was not found.</param>
        /// <returns></returns>
        T Get<T>(String key, T defaultValue);

        /// <summary>
        /// Gets the full data store item by the specified key.
        /// </summary>
        /// <param name="key">The key.</param>
        /// <returns></returns>
        IDataStoreItem GetItem(String key);

        /// <summary>
        /// Gets the full data store item by the specified key.
        /// </summary>
        /// <param name="key">The key.</param>
        /// <param name="defaultValue">Will execute put when the key was not found.</param>
        /// <returns></returns>
        IDataStoreItem GetItem(String key, Object defaultValue);

        /// <summary>
        /// Gets all the data store items in the collection.
        /// </summary>
        /// <returns></returns>
        List<IDataStoreItem> GetAll();

        /// <summary>
        /// Gets all the data store unsynchronized items in the collection.
        /// </summary>
        /// <returns></returns>
        List<IDataStoreItem> GetUnsynchronized();

        /// <summary>
        /// Deleted an item by the specified key.
        /// </summary>
        /// <param name="key">The key.</param>
        void Delete(String key);

        /// <summary>
        /// Deletes all items in the collection.
        /// </summary>
        void DeleteAll();

        /// <summary>
        /// Returns the number of items in the collection.
        /// </summary>
        /// <returns></returns>
        int Count();
    }
}