com.logicaldoc.core.security.dao

Interface FolderHistoryDAO

All Superinterfaces:

PersistentObjectDAO<FolderHistory>

All Known Implementing Classes:

HibernateFolderHistoryDAO

public interface FolderHistoryDAO
extends PersistentObjectDAO<FolderHistory>

DAO for FolderHistory handling.

Since:

5.0

Author:

Marco Meschieri - Logical Objects

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanOldHistories(int ttl) This method deletes all the user history entries oldest than the given days from now.
List<FolderHistory>	findByFolderId(long folderId) This method selects all histories of a given folder.
List<FolderHistory>	findByPath(String pathExpression, Date oldestDate, Collection<String> events, Integer max) This method finds all histories about a path (you can use expression)
List<FolderHistory>	findByUserId(long userId) This method selects all histories of a given user.
List<FolderHistory>	findByUserIdAndEvent(long userId, String event) This method selects all histories of a given user and related to the given event.
List<FolderHistory>	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

findByUserId

List<FolderHistory> findByUserId(long userId)

This method selects all histories of a given user.

Parameters:

userId -

Returns:

list of histories ordered by date

findByFolderId

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

findNotNotified

List<FolderHistory> findNotNotified(Integer max)

This method selects all histories not notified yet.

Returns:

max Optional maximum number of records

findByUserIdAndEvent

List<FolderHistory> findByUserIdAndEvent(long userId,
                                       String event)

This method selects all histories of a given user and related to the given event.

Parameters:

userId - The user identifier

event - The history event

Returns:

list of histories ordered by date

findByPath

List<FolderHistory> 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:

cleanOldHistories

void cleanOldHistories(int ttl)

This method deletes all the user 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

isEnabled

boolean isEnabled()

Checks if the histories recording is enabled