aswi20220x00-gitlab/Backend/Core/Services/DocumentService/IDocumentService.cs @ a35cb648

using Core.Entities;
using Models.Documents;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;


namespace Core.Services.DocumentService
{
    public interface IDocumentService
    {
        /// <summary>
        /// Add list of documents to a list of users
        /// </summary>
        /// <param name="request"></param>
        /// <param name="userId"></param>
        public void AddDocuments(DocumentAddRequest request, Guid userId);
        /// <summary>
        /// Returns all documents
        /// </summary>
        /// <returns></returns>
        public DocumentListResponse GetDocuments();
        /// <summary>
        /// Returns a preview of a document (HTML)
        /// </summary>
        /// <param name="documentId"></param>
        /// <returns></returns>
        public DocumentPreviewResponse GetDocumentPreview(Guid documentId);
        /// <summary>
        /// Delete a list of documents
        /// </summary>
        /// <param name="request"></param>
        public void DeleteDocuments(DeleteDocumentsRequest request);
        /// <summary>
        /// Set required number of annotations for a list of documents
        /// </summary>
        /// <param name="request"></param>
        public void SetRequiredAnnotationsForDocuments(SetRequiredAnnotationsRequest request);
        /// <summary>
        /// Set default required number of annotations
        /// </summary>
        /// <param name="requiredAnnotations"></param>
        public void SetRequiredAnnotationsGlobal(int requiredAnnotations);
        /// <summary>
        /// Get default required number of annotations
        /// </summary>
        /// <returns></returns>
        public int GetRequiredAnnotationsGlobal();
        /// <summary>
        /// Remove an annotator from a document
        /// </summary>
        /// <param name="documentId"></param>
        /// <param name="annotatorId"></param>
        public void RemoveAnnotatorFromDocument(Guid documentId, Guid annotatorId);
    }
}