Interface DocumentHistoryDAO

    • Method Detail

      • findByDocId

        List<DocumentHistory> findByDocId​(long docId)
        This method selects all histories of a given document.
        Parameters:
        docId - - ID of the document.
        Returns:
        list of histories ordered by date
      • findByDocIdAndEvent

        List<DocumentHistory> findByDocIdAndEvent​(long docId,
                                                  String event)
        This method selects all histories of a given document.
        Parameters:
        docId - - ID of the document.
        event - - Optional event code
        Returns:
        list of histories ordered by date
      • findByUserId

        List<DocumentHistory> findByUserId​(long userId)
        This method selects all histories of a given user.
        Parameters:
        userId - identifier of the user
        Returns:
        list of histories ordered by date
      • findByFolderId

        List<DocumentHistory> findByFolderId​(long folderId)
        This method selects all histories of a given folder.
        Parameters:
        folderId - - ID of the document.
        Returns:
        list of histories ordered by date
      • findByPath

        List<DocumentHistory> findByPath​(String pathExpression,
                                         Date oldestDate,
                                         Collection<String> events,
                                         Integer max)
        This method finds all histories about a path (you can use expression)
        Parameters:
        pathExpression - The path expression (like /Default/acme%)
        oldestDate - The older date for the retrieved histories
        events - events Optional list of event codes to be used as filter
        max - Optional maximum number of records
        Returns:
        list of histories
      • findNotNotified

        List<DocumentHistory> findNotNotified​(Integer max)
        This method selects all histories not notified yet.
        Parameters:
        max - Optional maximum number of records
        Returns:
        list of histories ordered by date
      • cleanOldHistories

        void cleanOldHistories​(int ttl)
        This method deletes all the document history entries oldest than the given days from now. If ttl is 0 or -1, the deletion is not made.
        Parameters:
        ttl - The maximum number of days over which the history is considered old
      • markHistoriesAsRead

        void markHistoriesAsRead​(String event,
                                 long userId)
        Marks all the histories of a specific event as read by the specified user.
        Parameters:
        event - the event name
        userId - identifier of the user
      • findByUserIdAndEvent

        List<DocumentHistory> findByUserIdAndEvent​(long userId,
                                                   String event,
                                                   String sessionId)
        This method selects all histories of a given user and related to the given event.
        Parameters:
        userId - The user identifier
        sessionId - The session identifier (optional)
        event - Code of the event (optional)
        Returns:
        list of histories ordered by date