Package com.logicaldoc.core.document
Interface DocumentListener
- All Known Implementing Classes:
DocumentInitializer
,DocumentValidator
public interface DocumentListener
This interface defines hooks called before and after a particular event
occurs on the specified document.
Each methods has access to a dictionary map that can be used through the execution pipeline in order to carry needed informations among all listeners.
- Since:
- 4.0
- Author:
- Marco Meschieri - LogicalDOC
-
Method Summary
Modifier and TypeMethodDescriptionvoid
afterCheckin
(Document document, DocumentHistory transaction, Map<String, Object> dictionary) Called after a document is checked invoid
afterSaveHistory
(Document document, DocumentHistory event, Map<String, Object> dictionary) Called after an event has been storedvoid
afterStore
(Document document, DocumentHistory transaction, Map<String, Object> dictionary) Called after a document is stored in the databasevoid
beforeCheckin
(Document document, DocumentHistory transaction, Map<String, Object> dictionary) Called before a document is checked invoid
beforeStore
(Document document, DocumentHistory transaction, Map<String, Object> dictionary) Called before a document is stored in the database
-
Method Details
-
beforeStore
void beforeStore(Document document, DocumentHistory transaction, Map<String, Object> dictionary) throws PersistenceExceptionCalled before a document is stored in the database- Parameters:
document
- The document to be storedtransaction
- Transaction informationsdictionary
- Dictionary of the execution pipeline- Throws:
PersistenceException
- raised if something went wrong
-
afterStore
void afterStore(Document document, DocumentHistory transaction, Map<String, Object> dictionary) throws PersistenceExceptionCalled after a document is stored in the database- Parameters:
document
- The document to be storedtransaction
- Transaction informationsdictionary
- Dictionary of the execution pipeline- Throws:
PersistenceException
- raised if something went wrong
-
beforeCheckin
void beforeCheckin(Document document, DocumentHistory transaction, Map<String, Object> dictionary) throws PersistenceExceptionCalled before a document is checked in- Parameters:
document
- The document to be checked intransaction
- Transaction informationsdictionary
- Dictionary of the execution pipeline- Throws:
PersistenceException
- raised if something went wrong
-
afterCheckin
void afterCheckin(Document document, DocumentHistory transaction, Map<String, Object> dictionary) throws PersistenceExceptionCalled after a document is checked in- Parameters:
document
- The document to be checked intransaction
- Transaction informationsdictionary
- Dictionary of the execution pipeline- Throws:
PersistenceException
- raised if something went wrong
-
afterSaveHistory
void afterSaveHistory(Document document, DocumentHistory event, Map<String, Object> dictionary) throws PersistenceExceptionCalled after an event has been stored- Parameters:
document
- The document the event is relative toevent
- The saved eventdictionary
- Dictionary of the execution pipeline- Throws:
PersistenceException
- raised if something went wrong
-