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

namespace Tango.TFS
{
    /// <summary>
    /// Represents a VSTS (Visual Studio On-line) client implementation.
    /// </summary>
    public interface ITeamFoundationServiceClient
    {
        /// <summary>
        /// Gets a team project by the specified name.
        /// </summary>
        /// <param name="name">The name.</param>
        /// <returns></returns>
        Task<Project> GetProject(String name);

        /// <summary>
        /// Uploads a work item to the specified team project.
        /// </summary>
        /// <param name="project">The project.</param>
        /// <param name="workItem">The work item.</param>
        /// <returns></returns>
        Task<WorkItem> UploadWorkItem(Project project, WorkItem workItem);

        /// <summary>
        /// Gets a work item by the specified team project and work item id.
        /// </summary>
        /// <param name="project">The project.</param>
        /// <param name="id">The identifier.</param>
        /// <returns></returns>
        Task<WorkItem> GetWorkItem(Project project, int id);

        /// <summary>
        /// Gets all work items of the specified type
        /// </summary>
        /// <param name="project">The project.</param>
        /// <param name="type">Work item type.</param>
        /// <returns></returns>
        Task<List<WorkItem>> GetWorkItemsByType(Project project, WorkItemType type);

        /// <summary>
        /// Gets all work items of the specified project.
        /// </summary>
        /// <param name="project">The project.</param>
        /// <returns></returns>
        Task<List<WorkItem>> GetAllWorkItems(Project project);

        /// <summary>
        /// Gets all the work items created by the specified team member.
        /// </summary>
        /// <param name="project">The project.</param>
        /// <param name="member">The member.</param>
        /// <returns></returns>
        Task<List<WorkItem>> GetWorkItemsCreatedBy(Project project, TeamMember member);

        /// <summary>
        /// Sets the state of the work item.
        /// </summary>
        /// <param name="project">The project.</param>
        /// <param name="item">The item.</param>
        /// <param name="state">The state.</param>
        /// <returns></returns>
        Task<WorkItem> SetWorkItemState(Project project, WorkItem item, State state);

        /// <summary>
        /// Sets the work item assignment.
        /// </summary>
        /// <param name="project">The project.</param>
        /// <param name="item">The item.</param>
        /// <param name="member">The member.</param>
        /// <returns></returns>
        Task<WorkItem> SetWorkItemAssignment(Project project, WorkItem item, TeamMember member);

        /// <summary>
        /// Adds a comment to the work item discussion.
        /// </summary>
        /// <param name="project">The project.</param>
        /// <param name="item">The item.</param>
        /// <param name="teamMember">Team member</param>
        /// <param name="comment">The comment.</param>
        /// <returns></returns>
        Task<WorkItem> AddWorkItemComment(Project project, WorkItem item, TeamMember teamMember, String comment);

        /// <summary>
        /// Deletes the specified work item.
        /// </summary>
        /// <param name="project">The project.</param>
        /// <param name="id">The identifier.</param>
        /// <returns></returns>
        Task DeleteWorkItem(Project project, int id);
    }
}