Package com.logicaldoc.core.document
Interface DocumentHistoryDAO
- All Superinterfaces:
PersistentObjectDAO<DocumentHistory>
- All Known Implementing Classes:
HibernateDocumentHistoryDAO
DAO for
DocumentHistory
handling.- Author:
- Michael Scholz, Alessandro Gasparini - LogicalDOC
-
Field Summary
Fields inherited from interface com.logicaldoc.core.PersistentObjectDAO
ENTITY
-
Method Summary
Modifier and TypeMethodDescriptionvoid
cleanOldHistories
(int ttl) This method deletes all the document history entries older than the given days from now.findByDocId
(long docId) This method selects all histories of a given document.findByDocIdAndEvent
(long docId, String event) This method selects all histories of a given document.findByFolderId
(long folderId) This method selects all histories of a given folder.findByPath
(String pathExpression, Date oldestDate, Collection<String> events, Integer max) This method finds all histories about a path (you can use expression)findByUserId
(long userId) This method selects all histories of a given user.findByUserIdAndEvent
(long userId, String event, String sessionId) This method selects all histories of a given user and related to the given event.findNotNotified
(Integer max) This method selects all histories not notified yet.void
markHistoriesAsRead
(String event, long userId) Marks all the histories of a specific event as read by the specified user.Methods inherited from interface com.logicaldoc.core.PersistentObjectDAO
bulkUpdate, delete, delete, deleteAll, deleteAll, findAll, findAll, findAllIds, findAllIds, findById, findById, findByObjectQuery, findByQuery, findByWhere, findByWhere, findIdsByWhere, findIdsByWhere, getDatabaseMetadata, getDbms, initialize, isOracle, jdbcUpdate, jdbcUpdate, query, query, queryForDouble, queryForDouble, queryForInt, queryForList, queryForList, queryForList, queryForLong, queryForLong, queryForObject, queryForRowSet, queryForRowSet, queryForString, store
-
Method Details
-
findByDocId
This method selects all histories of a given document.- Parameters:
docId
- - ID of the document.- Returns:
- list of histories ordered by date
- Throws:
PersistenceException
- Error in the database
-
findByDocIdAndEvent
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
- Throws:
PersistenceException
- Error in the database
-
findByUserId
This method selects all histories of a given user.- Parameters:
userId
- identifier of the user- Returns:
- list of histories ordered by date
- Throws:
PersistenceException
- Error in the database
-
findByFolderId
This method selects all histories of a given folder.- Parameters:
folderId
- - ID of the document.- Returns:
- list of histories ordered by date
- Throws:
PersistenceException
- Error in the database
-
findByPath
List<DocumentHistory> findByPath(String pathExpression, Date oldestDate, Collection<String> events, Integer max) throws PersistenceException 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 historiesevents
- events Optional list of event codes to be used as filtermax
- Optional maximum number of records- Returns:
- list of histories ordered by date asc
- Throws:
PersistenceException
- Error in the database
-
findNotNotified
This method selects all histories not notified yet.- Parameters:
max
- Optional maximum number of records- Returns:
- list of histories ordered by date
- Throws:
PersistenceException
- Error in the database
-
cleanOldHistories
This method deletes all the document history entries older than the given days from now. Ifttl
is 0 or -1, the deletion is not made.- Parameters:
ttl
- The maximum number of days over which the history is considered old- Throws:
PersistenceException
- Error in the database
-
markHistoriesAsRead
Marks all the histories of a specific event as read by the specified user.- Parameters:
event
- the event nameuserId
- identifier of the user- Throws:
PersistenceException
- Error in the database
-
findByUserIdAndEvent
List<DocumentHistory> findByUserIdAndEvent(long userId, String event, String sessionId) throws PersistenceException This method selects all histories of a given user and related to the given event.- Parameters:
userId
- The user identifiersessionId
- The session identifier (optional)event
- Code of the event (optional)- Returns:
- list of histories ordered by date
- Throws:
PersistenceException
- Error in the database
-