# Uses of Class
com.logicaldoc.core.document.DocumentHistory

Packages that use DocumentHistory
Package
Description
com.logicaldoc.core.automation
Automation subsystem that allows you to program your own logic inside the platform.
The automation engine can be accessed through the class `Automation`
Please note the special annotation `AutomationDictionary` that is used to automatically put in the Dictionary whatever bean you need.
com.logicaldoc.core.conversion
Machinery for converting documents to different formats.
com.logicaldoc.core.document
Contains the definitions of `Document` and `Version` as well as other related objects
com.logicaldoc.core.filler
Package with the API for implementing the autofill of `ExtensibleObject`s
com.logicaldoc.core.ticket
com.logicaldoc.core.transfer

## Uses of DocumentHistory in com.logicaldoc.core.automation

Methods in com.logicaldoc.core.automation that return types with arguments of type DocumentHistory
Modifier and Type
Method
Description
`List<DocumentHistory>`
DocTool.`getHistories(long docId, DocumentEvent event)`
Retrieve the list of events of a document
Methods in com.logicaldoc.core.automation with parameters of type DocumentHistory
Modifier and Type
Method
Description
`String`
DocTool.`displayUrl(DocumentHistory history)`
Builds the display url of a document(display permalink)
`String`
DocTool.`downloadUrl(DocumentHistory history)`
Builds the download url of a document(download permalink)
`void`
DocTool.`store(Document doc, DocumentHistory transaction)`
Saves / updates a document into the database

## Uses of DocumentHistory in com.logicaldoc.core.conversion

Methods in com.logicaldoc.core.conversion with parameters of type DocumentHistory
Modifier and Type
Method
Description
`Document`
FormatConversionManager.`convert(Document document, String fileVersion, String format, DocumentHistory transaction)`
Converts a document into another format and saves the resulting file in the same folder
`void`
FormatConversionManager.`convertToFile(Document document, String fileVersion, File out, DocumentHistory transaction)`
Converts a document and writes the content of the conversion into a file.

## Uses of DocumentHistory in com.logicaldoc.core.document

Methods in com.logicaldoc.core.document that return types with arguments of type DocumentHistory
Modifier and Type
Method
Description
`List<DocumentHistory>`
DocumentHistoryDAO.`findByDocId(long docId)`
This method selects all histories of a given document.
`List<DocumentHistory>`
HibernateDocumentHistoryDAO.`findByDocId(long docId)`
`List<DocumentHistory>`
DocumentHistoryDAO.`findByDocIdAndEvent(long docId, DocumentEvent event)`
This method selects all histories of a given document.
`List<DocumentHistory>`
HibernateDocumentHistoryDAO.`findByDocIdAndEvent(long docId, DocumentEvent event)`
`List<DocumentHistory>`
DocumentHistoryDAO.`findByFolderId(long folderId)`
This method selects all histories of a given folder.
`List<DocumentHistory>`
HibernateDocumentHistoryDAO.`findByFolderId(long folderId)`
`List<DocumentHistory>`
DocumentHistoryDAO.`findByPath(String pathExpression, Date oldestDate, Collection<String> events, Integer max)`
This method finds all histories about a path (you can use expression)
`List<DocumentHistory>`
HibernateDocumentHistoryDAO.`findByPath(String pathExpression, Date oldestDate, Collection<String> events, Integer max)`
`List<DocumentHistory>`
DocumentHistoryDAO.`findByUserId(long userId)`
This method selects all histories of a given user.
`List<DocumentHistory>`
HibernateDocumentHistoryDAO.`findByUserId(long userId)`
`List<DocumentHistory>`
DocumentHistoryDAO.`findByUserIdAndEvent(long userId, String event, String sessionId)`
This method selects all histories of a given user and related to the given event.
`List<DocumentHistory>`
HibernateDocumentHistoryDAO.`findByUserIdAndEvent(long userId, String event, String sessionId)`
`List<DocumentHistory>`
DocumentHistoryDAO.`findNotNotified(Integer max)`
This method selects all histories not notified yet.
`List<DocumentHistory>`
HibernateDocumentHistoryDAO.`findNotNotified(Integer max)`
Methods in com.logicaldoc.core.document with parameters of type DocumentHistory
Modifier and Type
Method
Description
`void`
DocumentInitializer.`afterCheckin(Document document, DocumentHistory transaction, Map<String,Object> dictionary)`
`void`
DocumentListener.`afterCheckin(Document document, DocumentHistory transaction, Map<String,Object> dictionary)`
Called after a document is checked in
`void`
DocumentValidator.`afterCheckin(Document document, DocumentHistory transaction, Map<String,Object> dictionary)`
`void`
DocumentInitializer.`afterFileStore(Document document, DocumentHistory transaction, Map<String,Object> dictionary)`
`void`
DocumentListener.`afterFileStore(Document document, DocumentHistory transaction, Map<String,Object> dictionary)`
Called after a document's file gets stored after a creation or checkin.
`void`
DocumentValidator.`afterFileStore(Document document, DocumentHistory transaction, Map<String,Object> dictionary)`
`void`
DocumentInitializer.`afterSaveHistory(Document document, DocumentHistory event, Map<String,Object> dictionary)`
`void`
DocumentListener.`afterSaveHistory(Document document, DocumentHistory event, Map<String,Object> dictionary)`
Called after an event has been stored
`void`
DocumentValidator.`afterSaveHistory(Document document, DocumentHistory event, Map<String,Object> dictionary)`
`void`
DocumentInitializer.`afterStore(Document document, DocumentHistory transaction, Map<String,Object> dictionary)`
`void`
DocumentListener.`afterStore(Document document, DocumentHistory transaction, Map<String,Object> dictionary)`
Called after a document is stored in the database
`void`
DocumentValidator.`afterStore(Document document, DocumentHistory transaction, Map<String,Object> dictionary)`
`void`
DocumentDAO.`applyParentFolderSecurity(long docId, DocumentHistory transaction)`
Replaces the document's security policies with those from the parent folder
`void`
HibernateDocumentDAO.`applyParentFolderSecurity(long docId, DocumentHistory transaction)`
`void`
DocumentDAO.`archive(long docId, DocumentHistory transaction)`
Archives a document
`void`
HibernateDocumentDAO.`archive(long docId, DocumentHistory transaction)`
`void`
DocumentManager.`archiveDocuments(Set<Long> docIds, DocumentHistory transaction)`
Archives all the documents in a folder's tree
`long`
DocumentManager.`archiveFolder(long folderId, DocumentHistory transaction)`
Archives all the documents in a folder's tree
`void`
DocumentInitializer.`beforeCheckin(Document document, DocumentHistory transaction, Map<String,Object> dictionary)`
`void`
DocumentListener.`beforeCheckin(Document document, DocumentHistory transaction, Map<String,Object> dictionary)`
Called before a document is checked in
`void`
DocumentValidator.`beforeCheckin(Document document, DocumentHistory transaction, Map<String,Object> dictionary)`
`void`
DocumentInitializer.`beforeStore(Document document, DocumentHistory transaction, Map<String,Object> dictionary)`
`void`
DocumentListener.`beforeStore(Document document, DocumentHistory transaction, Map<String,Object> dictionary)`
Called before a document is stored in the database
`void`
DocumentValidator.`beforeStore(Document document, DocumentHistory transaction, Map<String,Object> dictionary)`
`DocumentFuture`
DocumentManager.`checkin(long docId, File file, String filename, boolean release, Document docVO, DocumentHistory transaction)`
Checks in the given document
`DocumentFuture`
DocumentManager.`checkin(long docId, InputStream content, String filename, boolean release, Document docVO, DocumentHistory transaction)`
Checks in the given document
`void`
DocumentManager.`checkout(long docId, DocumentHistory transaction)`
Checks out the given document
`void`
DocumentManager.`checkout(Document document, DocumentHistory transaction)`
Checks out the given document
`DocumentFuture`
DocumentManager.`copyToFolder(Document doc, Folder folder, DocumentHistory transaction, boolean links, boolean notes, boolean security)`
Copy a document to the specified folder.
`DocumentFuture`
DocumentManager.`create(File file, Document docVO, DocumentHistory transaction)`
Creates a new Document.
`DocumentFuture`
DocumentManager.`create(InputStream content, Document docVO, DocumentHistory transaction)`
Creates a new Document.
`Document`
DocumentManager.`createAlias(Document doc, Folder folder, String aliasType, DocumentHistory transaction)`
Create an alias(shortcut) associated to the given doc to the specified folder.
`Ticket`
DocumentManager.`createTicket(Ticket ticket, DocumentHistory transaction)`
Creates a new ticket.
`void`
DocumentDAO.`delete(long docId, int delCode, DocumentHistory transaction)`
This method deletes the document object and insert a new document history entry.
`void`
DocumentDAO.`delete(long docId, DocumentHistory transaction)`
Shortcut for delete(docId, 1, transaction)
`void`
HibernateDocumentDAO.`delete(long docId, int delCode, DocumentHistory transaction)`
`void`
HibernateDocumentDAO.`delete(long docId, DocumentHistory transaction)`
`void`
DocumentDAO.`deleteAll(Collection<Document> documents, int delCode, DocumentHistory transaction)`
Deletes all documents form the database and modifies the custom ids of all documents
`void`
DocumentDAO.`deleteAll(Collection<Document> documents, DocumentHistory transaction)`
Shortcut for deleteAll(documents, 1, transaction)
`void`
HibernateDocumentDAO.`deleteAll(Collection<Document> documents, int delCode, DocumentHistory transaction)`
`void`
HibernateDocumentDAO.`deleteAll(Collection<Document> documents, DocumentHistory transaction)`
`Version`
DocumentManager.`deleteVersion(long versionId, DocumentHistory transaction)`
Deletes a specific version.
`int`
DocumentManager.`enforceFilesIntoFolderStore(long rootFolderId, DocumentHistory transaction)`
Moves all the files of the documents in the given tree from it's original location to the store defined in the owning folder
`long`
DocumentManager.`index(long docId, String content, DocumentHistory transaction)`
Re-indexes an existing document in the full-text index.
`void`
DocumentManager.`lock(long docId, DocumentStatus status, DocumentHistory transaction)`
Locks the given document
`void`
DocumentManager.`lock(Document document, DocumentStatus status, DocumentHistory transaction)`
Locks the given document, it is synchronized because under high-ferquency, Hibernate may fail
`void`
DocumentDAO.`makeImmutable(long docId, DocumentHistory transaction)`
Marks the document, with the given docId, as immutable.
`void`
DocumentManager.`makeImmutable(long docId, DocumentHistory transaction)`
Marks the document, with the given docId, as immutable and save the given document history
`void`
HibernateDocumentDAO.`makeImmutable(long docId, DocumentHistory transaction)`
`DocumentFuture`
DocumentManager.`merge(Collection<Document> documents, long targetFolderId, String fileName, DocumentHistory transaction)`
Merges a set of documents into a single PDF file
`DocumentFuture`
DocumentManager.`moveToFolder(Document doc, Folder folder, DocumentHistory transaction)`
Moves a document to the specified folder.
`void`
DocumentManager.`promoteVersion(long docId, String version, DocumentHistory transaction)`
Promotes an old version to the current default one.
`DocumentFuture`
DocumentManager.`rename(long docId, String newName, DocumentHistory transaction)`
Rename an existing document filename.
`DocumentFuture`
DocumentManager.`replaceAlias(long aliasId, DocumentHistory transaction)`
Replaces an alias with a copy of the original file
`DocumentFuture`
DocumentManager.`replaceFile(long docId, String fileVersion, File newFile, DocumentHistory transaction)`
Replaces the file of a given version
`DocumentFuture`
DocumentManager.`replaceFile(long docId, String fileVersion, InputStream content, DocumentHistory transaction)`
Replaces the file of a given version
`void`
DocumentDAO.`restore(long docId, long folderId, DocumentHistory transaction)`
Restores a previously deleted document
`void`
HibernateDocumentDAO.`restore(long docId, long folderId, DocumentHistory transaction)`
`void`
DocumentDAO.`saveDocumentHistory(Document doc, DocumentHistory transaction)`
Saves a document's history
`void`
HibernateDocumentDAO.`saveDocumentHistory(Document doc, DocumentHistory transaction)`
`void`
DocumentDAO.`setPassword(long docId, String password, DocumentHistory transaction)`
Protects the document with a password.
`void`
HibernateDocumentDAO.`setPassword(long docId, String password, DocumentHistory transaction)`
`void`
DocumentDAO.`store(Document doc, DocumentHistory transaction)`
This method persists the document object and insert a new document history entry
`void`
DocumentNoteDAO.`store(DocumentNote note, DocumentHistory transaction)`
Stores a note and saves the document's history
`void`
HibernateDocumentDAO.`store(Document doc, DocumentHistory transaction)`
`void`
HibernateDocumentNoteDAO.`store(DocumentNote note, DocumentHistory transaction)`
`void`
HibernateRatingDAO.`store(Rating rating, DocumentHistory transaction)`
`void`
RatingDAO.`store(Rating rating, DocumentHistory transaction)`
Stores a rating and saves the document's history
`void`
DocumentDAO.`unarchive(long docId, DocumentHistory transaction)`
Restores a previously archived document
`void`
HibernateDocumentDAO.`unarchive(long docId, DocumentHistory transaction)`
`void`
DocumentManager.`unlock(long docId, DocumentHistory transaction)`
Unchecks out the given document
`void`
DocumentDAO.`unsetPassword(long docId, DocumentHistory transaction)`
Removes the password protection from the document.
`void`
HibernateDocumentDAO.`unsetPassword(long docId, DocumentHistory transaction)`
`void`
DocumentManager.`update(Document document, Document docVO, DocumentHistory transaction)`
Updates an existing document and marks it to be re-indexed
`int`
HibernateRatingDAO.`updateDocumentRating(long docId, DocumentHistory transaction)`
`int`
RatingDAO.`updateDocumentRating(long docId, DocumentHistory transaction)`
Updates the document's rating with the votes average
Constructors in com.logicaldoc.core.document with parameters of type DocumentHistory
Modifier
Constructor
Description
``
`DocumentHistory(DocumentHistory source)`

## Uses of DocumentHistory in com.logicaldoc.core.filler

Methods in com.logicaldoc.core.filler with parameters of type DocumentHistory
Modifier and Type
Method
Description
`void`
Filler.`fill(Document document, DocumentHistory transaction, Map<String,Object> dictionary)`
Fills a document using the body text as input

## Uses of DocumentHistory in com.logicaldoc.core.ticket

Methods in com.logicaldoc.core.ticket with parameters of type DocumentHistory
Modifier and Type
Method
Description
`void`
TicketListener.`afterStore(Ticket ticket, DocumentHistory transaction, Map<String,Object> dictionary)`
Called after a ticket is stored in the database
`void`
TicketListener.`beforeStore(Ticket ticket, DocumentHistory transaction, Map<String,Object> dictionary)`
Called before a ticket is stored in the database
`void`
HibernateTicketDAO.`store(Ticket ticket, DocumentHistory transaction)`
`void`
TicketDAO.`store(Ticket ticket, DocumentHistory transaction)`
This method persists the download ticket object and insert a new document history entry

## Uses of DocumentHistory in com.logicaldoc.core.transfer

Methods in com.logicaldoc.core.transfer with parameters of type DocumentHistory
Modifier and Type
Method
Description
`ByteArrayOutputStream`
ZipExport.`process(Long[] docIds, boolean pdfConversion, DocumentHistory transaction)`
Exports a selection of documents
`void`
ZipExport.`process(Long[] docIds, OutputStream out, boolean pdfConversion, DocumentHistory transaction)`
Exports a selection of documents