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.document.dao
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, String 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	FormatConverterManager.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	FormatConverterManager.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 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.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	DocumentManager.archiveDocuments(long[] docIds, DocumentHistory transaction)	Archives all the documents in a folder's tree
void	DocumentManagerImpl.archiveDocuments(long[] docIds, DocumentHistory transaction)
long	DocumentManager.archiveFolder(long folderId, DocumentHistory transaction)	Archives all the documents in a folder's tree
long	DocumentManagerImpl.archiveFolder(long folderId, DocumentHistory transaction)
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)
void	DocumentManager.checkin(long docId, File file, String filename, boolean release, AbstractDocument docVO, DocumentHistory transaction)	Checks in the given document
void	DocumentManager.checkin(long docId, InputStream fileInputStream, String filename, boolean release, AbstractDocument docVO, DocumentHistory transaction)	Checks in the given document
void	DocumentManagerImpl.checkin(long docId, File file, String filename, boolean release, AbstractDocument docVO, DocumentHistory transaction)
void	DocumentManagerImpl.checkin(long docId, InputStream content, String filename, boolean release, AbstractDocument docVO, DocumentHistory transaction)
void	DocumentManager.checkout(long docId, DocumentHistory transaction)	Checks out the given document
void	DocumentManagerImpl.checkout(long docId, DocumentHistory transaction)
Document	DocumentManager.copyToFolder(Document doc, Folder folder, DocumentHistory transaction)	Copy a document to the specified folder.
Document	DocumentManagerImpl.copyToFolder(Document doc, Folder folder, DocumentHistory transaction)
Document	DocumentManager.create(File file, Document docVO, DocumentHistory transaction)	Creates a new Document.
Document	DocumentManager.create(InputStream content, Document docVO, DocumentHistory transaction)	Creates a new Document.
Document	DocumentManagerImpl.create(File file, Document docVO, DocumentHistory transaction)
Document	DocumentManagerImpl.create(InputStream content, Document docVO, DocumentHistory transaction)
Document	DocumentManager.createAlias(Document doc, Folder folder, String type, DocumentHistory transaction)	Create an alias(shortcut) associated to the given doc to the specified folder.
Document	DocumentManagerImpl.createAlias(Document doc, Folder folder, String aliasType, DocumentHistory transaction)
Ticket	DocumentManager.createDownloadTicket(long docId, String suffix, Integer expireHours, Date expireDate, Integer maxDownloads, String urlPrefix, DocumentHistory transaction)	Creates a new download ticket.
Ticket	DocumentManagerImpl.createDownloadTicket(long docId, String suffix, Integer expireHours, Date expireDate, Integer maxDownloads, String urlPrefix, DocumentHistory transaction)
Version	DocumentManager.deleteVersion(long versionId, DocumentHistory transaction)	Deletes a specific version.
Version	DocumentManagerImpl.deleteVersion(long versionId, DocumentHistory transaction)
int	DocumentManager.enforceFilesIntoFolderStorage(long rootFolderId, DocumentHistory transaction)	Moves all the files of the documents in the given tree from it's original location to the storage defined in the owning folder
int	DocumentManagerImpl.enforceFilesIntoFolderStorage(long rootFolderId, DocumentHistory transaction)
long	DocumentManager.index(long docId, String content, DocumentHistory transaction)	Re-indexes an existing document in the full-text index.
long	DocumentManagerImpl.index(long docId, String content, DocumentHistory transaction)
void	DocumentManager.lock(long docId, int status, DocumentHistory transaction)	Locks the given document
void	DocumentManagerImpl.lock(long docId, int status, DocumentHistory transaction)
void	DocumentManager.makeImmutable(long docId, DocumentHistory transaction)	Marks the document, with the given docId, as immutable and save the given document history
void	DocumentManagerImpl.makeImmutable(long docId, DocumentHistory transaction)
Document	DocumentManager.merge(Collection<Document> documents, long targetFolderId, String fileName, DocumentHistory transaction)	Merges a set of documents into a single PDF file
Document	DocumentManagerImpl.merge(Collection<Document> documents, long targetFolderId, String fileName, DocumentHistory transaction)
void	DocumentManager.moveToFolder(Document doc, Folder folder, DocumentHistory transaction)	Moves a document to the specified folder.
void	DocumentManagerImpl.moveToFolder(Document doc, Folder folder, DocumentHistory transaction)
void	DocumentManager.promoteVersion(long docId, String version, DocumentHistory transaction)	Promotes an old version to the current default one.
void	DocumentManagerImpl.promoteVersion(long docId, String version, DocumentHistory transaction)
void	DocumentManager.rename(long docId, String newName, DocumentHistory transaction)	Rename an existing document filename.
void	DocumentManagerImpl.rename(long docId, String newName, DocumentHistory transaction)
Document	DocumentManager.replaceAlias(long aliasId, DocumentHistory transaction)	Replaces an alias with a copy of the original file
Document	DocumentManagerImpl.replaceAlias(long aliasId, DocumentHistory transaction)
void	DocumentManager.replaceFile(long docId, String fileVersion, File newFile, DocumentHistory transaction)	Replaces the file of a given version
void	DocumentManager.replaceFile(long docId, String fileVersion, InputStream newFile, DocumentHistory transaction)	Replaces the file of a given version
void	DocumentManagerImpl.replaceFile(long docId, String fileVersion, File newFile, DocumentHistory transaction)
void	DocumentManagerImpl.replaceFile(long docId, String fileVersion, InputStream content, DocumentHistory transaction)
void	DocumentManager.unlock(long docId, DocumentHistory transaction)	UNChecks out the given document
void	DocumentManagerImpl.unlock(long docId, DocumentHistory transaction)
void	DocumentManager.update(Document doc, Document docVO, DocumentHistory transaction)	Updates an existing document and marks it to be re-indexed
void	DocumentManagerImpl.update(Document document, Document docVO, DocumentHistory transaction)

Constructors in com.logicaldoc.core.document with parameters of type DocumentHistory

Modifier	Constructor	Description
	DocumentHistory(DocumentHistory source)

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

Methods in com.logicaldoc.core.document.dao 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, String event)	This method selects all histories of a given document.
List<DocumentHistory>	HibernateDocumentHistoryDAO.findByDocIdAndEvent(long docId, String 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.dao with parameters of type DocumentHistory

Modifier and Type	Method	Description
void	DocumentDAO.archive(long docId, DocumentHistory transaction)	Archives a document
void	HibernateDocumentDAO.archive(long docId, DocumentHistory transaction)
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)
void	DocumentDAO.makeImmutable(long docId, DocumentHistory transaction)	Marks the document, with the given docId, as immutable.
void	HibernateDocumentDAO.makeImmutable(long docId, DocumentHistory transaction)
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	HibernateDocumentHistoryDAO.store(DocumentHistory history)
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	DocumentDAO.unsetPassword(long docId, DocumentHistory transaction)	Removes the password protection from the document.
void	HibernateDocumentDAO.unsetPassword(long docId, DocumentHistory transaction)
int	HibernateRatingDAO.updateDocumentRating(long docId, DocumentHistory transaction)
int	RatingDAO.updateDocumentRating(long docId, DocumentHistory transaction)	Updates the document's rating with the votes average

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	HibernateTicketDAO.store(Ticket entity, 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