com.logicaldoc.core.document

Interface DocumentManager

All Known Implementing Classes:

DocumentManagerImpl

public interface DocumentManager

A general manager for documents handling issues

Since:

3.5

Author:

Marco Meschieri - Logical Objects

Method Summary

Methods

Modifier and Type	Method and Description
void	changeIndexingStatus(Document doc, int status) Utility method used to declare that: a document must be taken into consideration by the indexer (status = AbstractDocument.INDEX_TO_INDEX).
void	checkin(long docId, File file, String filename, boolean release, Document docVO, History transaction) Checks in the given document
void	checkin(long docId, InputStream fileInputStream, String filename, boolean release, Document docVO, History transaction) Checks in the given document
void	checkout(long docId, History history) Checks out the given document
Document	copyToFolder(Document doc, Folder folder, History transaction) Copy a document to the specified folder.
Document	create(File file, Document docVO, History transaction) Creates a new Document.
Document	create(InputStream content, Document docVO, History transaction) Creates a new Document.
Document	createShortcut(Document doc, Folder folder, History transaction) Create a shortcut associated to the given doc to the specified folder.
void	deleteFromIndex(Document doc) Utility method for document removal from index and database update(flag indexed)
Version	deleteVersion(long versionId, History transition) Deletes a specific version.
void	lock(long docId, int status, History transaction) Locks the given document
void	makeImmutable(long docId, History transaction) Marks the document, with the given docId, as immutable and save the given document history
void	moveToFolder(Document doc, Folder folder, History transaction) Moves a document to the specified folder.
void	reindex(long docId) Reindexes an existing document in the full-text index.
void	rename(Document doc, String newName, boolean title, History transaction) Rename an existing document title/filename.
void	setStorer(Storer storer)
void	unlock(long docId, History transaction) UNChecks out the given document
void	update(Document doc, Document docVO, History transaction) Updates an existing document and marks it to be re-indexed

Method Detail

checkin

void checkin(long docId,
           InputStream fileInputStream,
           String filename,
           boolean release,
           Document docVO,
           History transaction)
             throws Exception

Checks in the given document

Parameters:

docId - the document to be checked in

fileInputStream - input stream pointing to the new document version

filename - new filename (can also be the old one)

release - True if this is a new release(eg: 2.0) rather than a subversion(eg: 1.1)

docVO - The value object containing document's metadata applied during the checkin (optional)

transaction - entry to log the event, set the user and comment

Throws:

Exception - if an error occurs, this exception is thrown

checkin

void checkin(long docId,
           File file,
           String filename,
           boolean release,
           Document docVO,
           History transaction)
             throws Exception

Checks in the given document

Parameters:

docId - the document to be checked in

file - of the new document version

filename - new filename (can also be the old one)

release - True if this is a new release(eg: 2.0) rather than a subversion(eg: 1.1)

docVO - The value object containing document's metadata applied during the checkin (optional)

transaction - entry to log the event, set the user and comment

Throws:

Exception - if an error occurs, this exception is thrown

checkout

void checkout(long docId,
            History history)
              throws Exception

Checks out the given document

Parameters:

docId - the document to be checked out

transaction - entry to log the event (set the user)

Throws:

Exception - if an error occurs, this exception is thrown

lock

void lock(long docId,
        int status,
        History transaction)
          throws Exception

Locks the given document

Parameters:

docId - the document to be locked

status - the lock type (used to populate status attribute of the document)

transaction - entry to log the event (set the user)

Throws:

Exception - if an error occurs, this exception is thrown

unlock

void unlock(long docId,
          History transaction)
            throws Exception

UNChecks out the given document

Parameters:

docId - the document to be unchecked out

transaction - entry to log the event

Throws:

Exception - if an error occurs, this exception is thrown

create

Document create(File file,
              Document docVO,
              History transaction)
                throws Exception

Creates a new Document. Saves the information provided. That also includes updating the search index for example.

Parameters:

file - The document's file

docVO - The value object containing the document's metadata

transaction - The trandaction metadata (remember to set the user and the comment)

Returns:

The newly created document

Throws:

Exception

create

Document create(InputStream content,
              Document docVO,
              History transaction)
                throws Exception

Creates a new Document. Saves the information provided. That also includes updating the search index for example.

Parameters:

content - The document's content

docVO - The value object containing the document's metadata

transaction - The transaction metadata (remember to set the user and the comment)

Returns:

The newly created document

Throws:

Exception

reindex

void reindex(long docId)
             throws Exception

Reindexes an existing document in the full-text index.

Parameters:

docId - The document to be indexed

Throws:

Exception - if an error occurs, this exception is thrown

rename

void rename(Document doc,
          String newName,
          boolean title,
          History transaction)
            throws Exception

Rename an existing document title/filename.

Parameters:

doc - The document to be renamed

newName - The new title/filename of the document

title - True if the title must be renamed, False for the filename

transaction - entry to log the event (set the user)

Throws:

Exception - if an error occurs, this exception is thrown

update

void update(Document doc,
          Document docVO,
          History transaction)
            throws Exception

Updates an existing document and marks it to be re-indexed

Parameters:

doc - The document to be updated

docVO - value object containing the new metadata

transaction - entry to log the event (set the user)

Throws:

Exception - if an error occurs, this exception is thrown

deleteFromIndex

void deleteFromIndex(Document doc)

Utility method for document removal from index and database update(flag indexed)

changeIndexingStatus

void changeIndexingStatus(Document doc,
                        int status)

Utility method used to declare that:

1. a document must be taken into consideration by the indexer (status = AbstractDocument.INDEX_TO_INDEX).
2. a document must not be taken into consideration by the indexer (status = AbstractDocument.INDEX_SKIP). If the document was previously indexed it is removed from the index.

Status:

1. AbstractDocument.INDEX_TO_INDEX
2. AbstractDocument.INDEX_SKIP

Parameters:

doc - The document for which will be changed the indexer status.

status - The new document indexer status.

makeImmutable

void makeImmutable(long docId,
                 History transaction)
                   throws Exception

Marks the document, with the given docId, as immutable and save the given document history

Parameters:

docId -

transaction - entry to log the event (set the user)

Throws:

Exception

moveToFolder

void moveToFolder(Document doc,
                Folder folder,
                History transaction)
                  throws Exception

Moves a document to the specified folder. All stores(db, file system, index) will be consequently altered.

Parameters:

doc - The document to move

folder - The target folder

transaction - entry to log the event (set the user)

Throws:

Exception

copyToFolder

Document copyToFolder(Document doc,
                    Folder folder,
                    History transaction)
                      throws Exception

Copy a document to the specified folder.

Parameters:

doc - The document to move

folder - The target folder

transaction - entry to log the event (set the user)

Returns:

The created document

Throws:

Exception

createShortcut

Document createShortcut(Document doc,
                      Folder folder,
                      History transaction)
                        throws Exception

Create a shortcut associated to the given doc to the specified folder.

Parameters:

doc - The document for which will be created the shortcut

folder - The target folder

transaction - entry to log the event (set the user)

Returns:

The created document

Throws:

Exception

deleteVersion

Version deleteVersion(long versionId,
                    History transition)
                      throws Exception

Deletes a specific version.

Parameters:

versionId - The version to delete

transaction - entry to log the event (set the user)

Returns:

the latest version

Throws:

Exception

setStorer

void setStorer(Storer storer)