aswi20220x00-gitlab/Backend/Core/Services/AnnotationService/IAnnotationService.cs @ a35cb648

using Models.Annotations;
using Models.Documents;
using Models.Enums;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Core.Services.AnnotationService
{
    public interface IAnnotationService
    {
        /// <summary>
        /// Assign users to documents
        /// </summary>
        /// <param name="request"></param>
        /// <param name="userId"></param>
        public void CreateDocumentAnnotations(AnnotationsAddRequest request, Guid userId);
        /// <summary>
        /// Given user, return their annotations
        /// </summary>
        /// <param name="userId"></param>
        /// <returns></returns>
        public AnnotationListResponse GetUserAnnotations(Guid userId);
        /// <summary>
        /// Return given annotation
        /// </summary>
        /// <param name="annotationId"></param>
        /// <param name="userId"></param>
        /// <param name="userRole"></param>
        /// <param name="isFinal">is it final annotation or standard annotation</param>
        /// <returns></returns>
        public AnnotationInfo GetAnnotation(Guid annotationId, Guid userId, ERole userRole, bool isFinal);
        /// <summary>
        /// Adds a tag to an annotation
        /// </summary>
        /// <param name="annotationId"></param>
        /// <param name="userId"></param>
        /// <param name="userRole"></param>
        /// <param name="request"></param>
        /// <param name="isFinal">is it final annotation or standard annotation</param>
        public void AddAnnotationInstance(Guid annotationId, Guid userId, ERole userRole, AnnotationInstanceAddRequest request, bool isFinal);
        /// <summary>
        /// Remove a tag from annotation
        /// </summary>
        /// <param name="annotationId"></param>
        /// <param name="tagInstanceId"></param>
        /// <param name="loggedUserId"></param>
        /// <param name="userRole"></param>
        /// <param name="isFinal">is it final annotation or standard annotation</param>
        public void DeleteAnnotationInstance(Guid annotationId, Guid tagInstanceId, Guid loggedUserId, ERole userRole, bool isFinal);
        /// <summary>
        /// Add note to annotation
        /// </summary>
        /// <param name="annotationId"></param>
        /// <param name="userId"></param>
        /// <param name="userRole"></param>
        /// <param name="request"></param>
        /// <param name="isFinal">is it final annotation or standard annotation</param>
        public void AddNoteToAnnotation(Guid annotationId, Guid userId, ERole userRole, AddNoteToAnnotationRequest request, bool isFinal);
        /// <summary>
        /// Set sentiment of a tag
        /// </summary>
        /// <param name="annotationId"></param>
        /// <param name="instanceId"></param>
        /// <param name="userId"></param>
        /// <param name="userRole"></param>
        /// <param name="sentiment"></param>
        /// <param name="isFinal">is it final annotation or standard annotation</param>
        public void SetTagInstanceSentiment(Guid annotationId, Guid instanceId, Guid userId, ERole userRole, ETagSentiment sentiment, bool isFinal);
        /// <summary>
        /// Set the annotation state to DONE or IN_PROGRESS
        /// </summary>
        /// <param name="annotationId"></param>
        /// <param name="userId"></param>
        /// <param name="userRole"></param>
        /// <param name="done">is it DONE or not</param>
        /// <param name="isFinal"is it final annotation or standard annotation></param>
        public void MarkAnnotationAsDone(Guid annotationId, Guid userId, ERole userRole, bool done, bool isFinal);
        /// <summary>
        /// Creates a final annotation
        /// </summary>
        /// <param name="documentId"></param>
        /// <param name="userId"></param>
        /// <returns>ID of the final annotation</returns>
        public Guid CreateFinalAnnotation(Guid documentId, Guid userId);
        /// <summary>
        /// Performs an export
        /// </summary>
        /// <param name="request"></param>
        /// <returns>ZIP memory stream</returns>
        public MemoryStream Export(ExportRequest request);
        /// <summary>
        /// Marks tag as final 
        /// </summary>
        /// <param name="annotationId"></param>
        /// <param name="occurenceId"></param>
        /// <param name="isFinal">is the tag final or not</param>
        public void SetTagIsFinal(Guid annotationId, Guid occurenceId, bool isFinal);
    }
}