Interface DocumentNoteDAO

All Superinterfaces:
PersistentObjectDAO<DocumentNote>
All Known Implementing Classes:
HibernateDocumentNoteDAO

public interface DocumentNoteDAO extends PersistentObjectDAO<DocumentNote>
DAO for DocumentNote handling.
Since:
6.2
Author:
Matteo Caruso - LogicalDOC
  • Method Details

    • store

      void store(DocumentNote note, DocumentHistory transaction) throws PersistenceException
      Stores a note and saves the document's history
      Parameters:
      note - the note
      transaction - session informations
      Throws:
      PersistenceException - error at data layer
    • findByDocId

      List<DocumentNote> findByDocId(long docId, String fileVersion) throws PersistenceException
      This method finds the list of document notes regarding a document with the given ID
      Parameters:
      docId - ID of the document.
      fileVersion - indicates a specific file version, optional
      Returns:
      The list of document note
      Throws:
      PersistenceException - Error in the database
    • findByDocIdAndType

      List<DocumentNote> findByDocIdAndType(long docId, String fileVersion, String type) throws PersistenceException
      This method finds the list of document notes regarding a document with the given ID and optionally filter on the type
      Parameters:
      docId - ID of the document
      fileVersion - indicates a specific file version, optional
      type - note type, optional
      Returns:
      The list of document note
      Throws:
      PersistenceException - Error in the database
    • findByDocIdAndTypes

      List<DocumentNote> findByDocIdAndTypes(long docId, String fileVersion, Collection<String> types) throws PersistenceException
      This method finds the list of document notes regarding a document with the given ID and optionally filter on a collection of types
      Parameters:
      docId - ID of the document
      fileVersion - indicates a specific file version, optional
      types - collection of admitted note types, optional
      Returns:
      The list of document note
      Throws:
      PersistenceException - Error in the database
    • copyAnnotations

      int copyAnnotations(long docId, String oldFileVersion, String newFileVersion) throws PersistenceException
      Copies all the notes not associated to a specific page from a given file version to another
      Parameters:
      docId - The document ID
      oldFileVersion - the old version
      newFileVersion - the version to copy to
      Returns:
      Number of copied notes
      Throws:
      PersistenceException - If an error occurs in the database
    • findByUserId

      List<DocumentNote> findByUserId(long userId) throws PersistenceException
      This method finds the list of document notes regarding posted by a specific user
      Parameters:
      userId - ID of the user
      Returns:
      The list of document notes ordered by descending date
      Throws:
      PersistenceException - Errorin the database