com.logicaldoc.core.document.dao

Interface HistoryDAO

All Superinterfaces:

PersistentObjectDAO<History>

All Known Implementing Classes:

HibernateHistoryDAO

public interface HistoryDAO
extends PersistentObjectDAO<History>

DAO for History handling.

Author:

Michael Scholz, Alessandro Gasparini - Logical Objects

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanOldHistories(int ttl) This method deletes all the document history entries oldest than the given days from now.
List<History>	findByDocId(long docId) This method selects all histories of a given document.
List<History>	findByFolderId(long folderId) This method selects all histories of a given folder.
List<History>	findByPath(String pathExpression, Date oldestDate, Collection<String> events, Integer max) This method finds all histories about a path (you can use expression)
List<History>	findByUserId(long userId) This method selects all histories of a given user.
List<History>	findByUserIdAndEvent(long userId, String event, String sessionId) This method selects all histories of a given user and related to the given event.
List<History>	findNotNotified(Integer max) This method selects all histories not notified yet.
boolean	isEnabled() Checks if the histories recording is enabled

Methods inherited from interface com.logicaldoc.core.PersistentObjectDAO

bulkUpdate, delete, deleteAll, findAll, findAllIds, findById, findByQuery, findByWhere, findByWhere, findIdsByWhere, findIdsByWhere, getDbms, initialize, jdbcUpdate, jdbcUpdate, query, queryForInt, queryForList, queryForList, queryForLong, queryForRowSet, store

Method Detail

findByDocId

List<History> 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

findByUserId

List<History> findByUserId(long userId)

This method selects all histories of a given user.

Parameters:

userId -

Returns:

list of histories ordered by date

findByFolderId

List<History> 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<History> 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

max - Optional maximum number of records

Returns:

findNotNotified

List<History> findNotNotified(Integer max)

This method selects all histories not notified yet.

Returns:

max Optional maximum number of records

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 cancellation is not made.

Parameters:

ttl - The maximum number of days over which the history is considered old

findByUserIdAndEvent

List<History> 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 - The string represtation of history event (optional)

Returns:

list of histories ordered by date

isEnabled

boolean isEnabled()

Checks if the histories recording is enabled