com.openkm.module

Interface DocumentModule

All Known Implementing Classes:

DbDocumentModule, JcrDocumentModule, OKMDocument

public interface DocumentModule

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelCheckout(String token, String docPath) Cancel a previous checked out state in a document.
Version	checkin(String token, String docPath, InputStream is, String comment) Check in the document to create a new version.
void	checkout(String token, String docPath) Checkout the document to edit it.
void	copy(String token, String docPath, String dstPath) Copy a document to another location in the repository.
Document	create(String token, Document doc, InputStream is) Creates a new document in the repository.
void	delete(String token, String docPath) Deletes a document from the repository.
void	forceCancelCheckout(String token, String docPath) Force to cancel a previous checked out state in a document.
void	forceUnlock(String token, String docPath) For document unlock, so will be editable for other users.
List<Document>	getChildren(String token, String fldPath) Retrieve a list of children documents from an existing folder.
List<Document>	getChilds(String token, String fldPath) Deprecated.
InputStream	getContent(String token, String docPath, boolean checkout) Obtain document content from the repository.
InputStream	getContentByVersion(String token, String docPath, String versionId) Obtain document content from the repository.
LockInfo	getLockInfo(String token, String docPath) Returns a lock information.
String	getPath(String token, String uuid) Get the document path from a UUID
Document	getProperties(String token, String docPath) Obtain document properties from the repository.
List<Version>	getVersionHistory(String token, String docPath) Get the document version history.
long	getVersionHistorySize(String token, String docPath) Get the version size of a Document.
boolean	isCheckedOut(String token, String docPath) Test if a node has been already checked out.
boolean	isLocked(String token, String docPath) Tell if a document is locked.
boolean	isValid(String token, String docId) Test if a document path is valid.
LockInfo	lock(String token, String docPath) Lock a document, so only is editable by the locker.
void	move(String token, String docPath, String fldPath) Move a document to another location in the repository.
void	purge(String token, String docPath) Deletes definitively a document from the repository.
void	purgeVersionHistory(String token, String docPath) Purge a Document version history, so delete all previous versions but last one.
Document	rename(String token, String docPath, String newName) Rename a document in the repository.
void	restoreVersion(String token, String docPath, String versionId) Revert the document to an specific previous version.
void	setProperties(String token, Document doc) Set document properties in the repository.
void	unlock(String token, String docPath) Unlock a document, so will be editable for other users.

Method Detail

create

Document create(String token,
              Document doc,
              InputStream is)
                throws UnsupportedMimeTypeException,
                       FileSizeExceededException,
                       UserQuotaExceededException,
                       VirusDetectedException,
                       ItemExistsException,
                       PathNotFoundException,
                       AccessDeniedException,
                       RepositoryException,
                       IOException,
                       DatabaseException,
                       ExtensionException,
                       AutomationException

Creates a new document in the repository.

Parameters:

doc - A document object with the new document properties.

content - The document content in bytes.

Returns:

A document object with the properties of the new created document.

Throws:

UnsupportedMimeTypeException - If the uploaded file has an unsupported MIME type.

FileSizeExceededException - If the document content is biggest than the maximum accepted.

PathNotFoundException - If the parent folder doesn't exist.

ItemExistsException - If there is already a document in the repository with the same name.

AccessDeniedException - If there is any security problem: you can't modify the parent document folder because of lack of permissions.

RepositoryException - If there is any general repository problem.

IOException - An error when inserting document data into the repository.

UserQuotaExceededException

VirusDetectedException

DatabaseException

ExtensionException

AutomationException

delete

void delete(String token,
          String docPath)
            throws LockException,
                   PathNotFoundException,
                   AccessDeniedException,
                   RepositoryException,
                   DatabaseException,
                   ExtensionException

Deletes a document from the repository. It is a logical delete, so really is moved to the user trash and can be restored.

Parameters:

docPath - The path that identifies an unique document.

Throws:

LockException - Can't delete a locked document.

PathNotFoundException - If there is no document in this repository path.

AccessDeniedException - If there is any security problem: you can't modify the document because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

ExtensionException

rename

Document rename(String token,
              String docPath,
              String newName)
                throws PathNotFoundException,
                       ItemExistsException,
                       AccessDeniedException,
                       LockException,
                       RepositoryException,
                       DatabaseException,
                       ExtensionException

Rename a document in the repository.

Parameters:

docPath - The path that identifies an unique document.

newName - The new folder name.

Returns:

An document object with the new document properties.

Throws:

PathNotFoundException - If there is no document in this repository path.

ItemExistsException - If there is already a document in the repository with the same name in the same path.

AccessDeniedException - If there is any security problem: you can't modify the document because of lack of permissions.

RepositoryException - If there is any general repository problem.

LockException

DatabaseException

ExtensionException

getProperties

Document getProperties(String token,
                     String docPath)
                       throws PathNotFoundException,
                              RepositoryException,
                              DatabaseException

Obtain document properties from the repository.

Parameters:

docPath - The path that identifies an unique document.

Returns:

The document properties.

Throws:

PathNotFoundException - If there is no document in this repository path. you can't modify the document because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

setProperties

void setProperties(String token,
                 Document doc)
                   throws VersionException,
                          LockException,
                          PathNotFoundException,
                          AccessDeniedException,
                          RepositoryException,
                          DatabaseException

Set document properties in the repository.

Parameters:

doc - An document object with the properties

Throws:

VersionException - A document checked in can't be modified.

LockException - A locked document can't be modified.

PathNotFoundException - If there is no document in this repository path.

AccessDeniedException - If there is any security problem: you can't modify the document because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

getContent

InputStream getContent(String token,
                     String docPath,
                     boolean checkout)
                       throws PathNotFoundException,
                              AccessDeniedException,
                              RepositoryException,
                              IOException,
                              DatabaseException

Obtain document content from the repository.

Parameters:

docPath - The path that identifies an unique document.

Returns:

The content of the document file.

Throws:

PathNotFoundException - If there is no document in this repository path.

AccessDeniedException - If there is any security problem: you can't modify this document because of lack of permissions. Related to extended security.

RepositoryException - If there is any general repository problem.

IOException - An error when retrieving document data from the repository.

DatabaseException

getContentByVersion

InputStream getContentByVersion(String token,
                              String docPath,
                              String versionId)
                                throws RepositoryException,
                                       PathNotFoundException,
                                       IOException,
                                       DatabaseException

Obtain document content from the repository.

Parameters:

docPath - The path that identifies an unique document.

versionId - The id of the version to get the content from.

Returns:

The content of the document file.

Throws:

AccessDeniedException - If there is any security problem: you can't modify this document because of lack of permissions.

RepositoryException - If there is any general repository problem.

PathNotFoundException - If there is no folder in the repository with this path.

IOException - An error when retrieving document data from the repository.

DatabaseException

getChilds

@Deprecated
List<Document> getChilds(String token,
                                  String fldPath)
                         throws PathNotFoundException,
                                RepositoryException,
                                DatabaseException

Deprecated.

Retrieve a list of child documents from an existing folder.

Parameters:

fldPath - The path that identifies an unique folder.

Returns:

A Collection with the child documents.

Throws:

PathNotFoundException - If there is no folder in this repository path.

RepositoryException - If there is any general repository problem.

DatabaseException

getChildren

List<Document> getChildren(String token,
                         String fldPath)
                           throws PathNotFoundException,
                                  RepositoryException,
                                  DatabaseException

Retrieve a list of children documents from an existing folder.

Parameters:

fldPath - The path that identifies an unique folder.

Returns:

A Collection with the child documents.

Throws:

PathNotFoundException - If there is no folder in this repository path.

RepositoryException - If there is any general repository problem.

DatabaseException

checkout

void checkout(String token,
            String docPath)
              throws LockException,
                     PathNotFoundException,
                     AccessDeniedException,
                     RepositoryException,
                     DatabaseException

Checkout the document to edit it. The document can't be edited by another user until it is checked in o the checkout is canceled.

Parameters:

docPath - The path that identifies an unique document.

Throws:

LockException - A locked document can't be modified.

PathNotFoundException - If there is no document in this repository path.

AccessDeniedException - If there is any security problem: you can't modify the document because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

cancelCheckout

void cancelCheckout(String token,
                  String docPath)
                    throws LockException,
                           PathNotFoundException,
                           AccessDeniedException,
                           RepositoryException,
                           DatabaseException

Cancel a previous checked out state in a document.

Parameters:

docPath - The path that identifies an unique document.

Throws:

LockException - A locked document can't be modified.

PathNotFoundException - If there is no document in this repository path.

AccessDeniedException - If there is any security problem: you can't modify the document because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

forceCancelCheckout

void forceCancelCheckout(String token,
                       String docPath)
                         throws LockException,
                                PathNotFoundException,
                                AccessDeniedException,
                                RepositoryException,
                                DatabaseException,
                                PrincipalAdapterException

Force to cancel a previous checked out state in a document.

Parameters:

docPath - The path that identifies an unique document.

Throws:

LockException - A locked document can't be modified.

PathNotFoundException - If there is no document in this repository path.

AccessDeniedException - If there is any security problem: you can't modify the document because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

PrincipalAdapterException

isCheckedOut

boolean isCheckedOut(String token,
                   String docPath)
                     throws PathNotFoundException,
                            RepositoryException,
                            DatabaseException

Test if a node has been already checked out.

Parameters:

docPath - The path that identifies an unique document.

Returns:

True if the document is in checked out state, or false if not.

Throws:

PathNotFoundException - If there is no document in this repository path.

RepositoryException - If there is any general repository problem.

DatabaseException

checkin

Version checkin(String token,
              String docPath,
              InputStream is,
              String comment)
                throws FileSizeExceededException,
                       UserQuotaExceededException,
                       VirusDetectedException,
                       LockException,
                       VersionException,
                       PathNotFoundException,
                       AccessDeniedException,
                       RepositoryException,
                       IOException,
                       DatabaseException,
                       ExtensionException

Check in the document to create a new version.

Parameters:

docPath - The path that identifies an unique document.

comment - A comment for this checkin.

Returns:

A version object with the properties of the new generated version.

Throws:

LockException - A locked document can't be modified.

VersionException - If the nodes was not previously checked out.

PathNotFoundException - If there is no document in this repository path.

AccessDeniedException - If there is any security problem: you can't modify the document because of lack of permissions.

RepositoryException - If there is any general repository problem.

FileSizeExceededException

UserQuotaExceededException

VirusDetectedException

IOException

DatabaseException

ExtensionException

getVersionHistory

List<Version> getVersionHistory(String token,
                              String docPath)
                                throws PathNotFoundException,
                                       RepositoryException,
                                       DatabaseException

Get the document version history.

Parameters:

docPath - The path that identifies an unique document.

Returns:

A Collection of Versions with every document version.

Throws:

PathNotFoundException - If there is no document in this repository path.

RepositoryException - If there is any general repository problem.

DatabaseException

lock

LockInfo lock(String token,
            String docPath)
              throws LockException,
                     PathNotFoundException,
                     AccessDeniedException,
                     RepositoryException,
                     DatabaseException

Lock a document, so only is editable by the locker.

Parameters:

docPath - The path that identifies an unique document.

Throws:

LockException - If the node is already locked.

PathNotFoundException - If there is no document in this repository path.

AccessDeniedException - If there is any security problem: you can't modify the document because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

unlock

void unlock(String token,
          String docPath)
            throws LockException,
                   PathNotFoundException,
                   AccessDeniedException,
                   RepositoryException,
                   DatabaseException

Unlock a document, so will be editable for other users.

Parameters:

docPath - The path that identifies an unique document.

Throws:

LockException - If the node is not locked.

PathNotFoundException - If there is no document in this repository path.

AccessDeniedException - If there is any security problem: you can't modify the document because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

forceUnlock

void forceUnlock(String token,
               String docPath)
                 throws LockException,
                        PathNotFoundException,
                        AccessDeniedException,
                        RepositoryException,
                        DatabaseException,
                        PrincipalAdapterException

For document unlock, so will be editable for other users. This action need to be perfomed by and administrator.

Parameters:

docPath - The path that identifies an unique document.

Throws:

LockException - If the node is not locked.

PathNotFoundException - If there is no document in this repository path.

AccessDeniedException - If there is any security problem: you can't modify the document because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

PrincipalAdapterException

isLocked

boolean isLocked(String token,
               String docPath)
                 throws RepositoryException,
                        PathNotFoundException,
                        DatabaseException

Tell if a document is locked.

Parameters:

docPath - The path that identifies an unique document.

Returns:

True if the document is locked, and False otherwise.

Throws:

AccessDeniedException - If there is any security problem: you can't access this document because of lack of permissions.

RepositoryException - If there is any repository problem.

PathNotFoundException - If there is no document in the repository with this path.

DatabaseException

getLockInfo

LockInfo getLockInfo(String token,
                   String docPath)
                     throws RepositoryException,
                            PathNotFoundException,
                            LockException,
                            DatabaseException

Returns a lock information.

Parameters:

docPath - The path that identifies an unique document.

Returns:

The lock info.

Throws:

AccessDeniedException - If there is any security problem: you can't access this document because of lack of permissions.

RepositoryException - If there is any repository problem.

PathNotFoundException - If there is no document in the repository with this path.

LockException - If the node is not locked.

DatabaseException

purge

void purge(String token,
         String docPath)
           throws LockException,
                  AccessDeniedException,
                  RepositoryException,
                  PathNotFoundException,
                  DatabaseException,
                  ExtensionException

Deletes definitively a document from the repository. It is a physical delete, so the document can't be restored.

Parameters:

docPath - The path that identifies an unique document.

Throws:

AccessDeniedException - If there is any security problem: you can't access this document because of lack of permissions.

RepositoryException - If there is any general repository problem.

PathNotFoundException - If there is no document in the repository with this path.

LockException

DatabaseException

ExtensionException

move

void move(String token,
        String docPath,
        String fldPath)
          throws PathNotFoundException,
                 ItemExistsException,
                 AccessDeniedException,
                 LockException,
                 RepositoryException,
                 DatabaseException,
                 ExtensionException,
                 AutomationException

Move a document to another location in the repository.

Parameters:

docPath - The path that identifies an unique document.

fldPath - The destination folder path.

Throws:

PathNotFoundException - If the dstPath does not exists

ItemExistsException - If there is already a document in the destination folder with the same name.

AccessDeniedException - If there is any security problem: you can't modify the document's parent folder or the destination folder because of lack of permissions.

RepositoryException - If there is any general repository problem.

LockException

DatabaseException

ExtensionException

AutomationException

copy

void copy(String token,
        String docPath,
        String dstPath)
          throws ItemExistsException,
                 PathNotFoundException,
                 AccessDeniedException,
                 RepositoryException,
                 IOException,
                 DatabaseException,
                 UserQuotaExceededException,
                 ExtensionException,
                 AutomationException

Copy a document to another location in the repository.

Parameters:

docPath - The path that identifies an unique document.

dstPath - The destination folder path.

Throws:

PathNotFoundException - If the dstPath does not exists

ItemExistsException - If there is already a document in the destination folder with the same name.

AccessDeniedException - If there is any security problem: you can't modify the document's parent folder or the destination folder because of lack of permissions.

RepositoryException - If there is any general repository problem.

IOException

DatabaseException

UserQuotaExceededException

ExtensionException

AutomationException

restoreVersion

void restoreVersion(String token,
                  String docPath,
                  String versionId)
                    throws PathNotFoundException,
                           AccessDeniedException,
                           LockException,
                           RepositoryException,
                           DatabaseException,
                           ExtensionException

Revert the document to an specific previous version.

Parameters:

docPath - The path that identifies an unique document.

versionId - The version id to revert to.

Throws:

PathNotFoundException - If there is no document in this repository path.

AccessDeniedException - If there is any security problem: you can't modify the document because of lack of permissions.

RepositoryException - If there is any general repository problem.

LockException

DatabaseException

ExtensionException

purgeVersionHistory

void purgeVersionHistory(String token,
                       String docPath)
                         throws AccessDeniedException,
                                PathNotFoundException,
                                LockException,
                                RepositoryException,
                                DatabaseException

Purge a Document version history, so delete all previous versions but last one. Used to free Document version size.

Parameters:

docPath - The path that identifies an unique document.

Throws:

AccessDeniedException - If there is any security problem: you can't access this folder because of lack of permissions.

RepositoryException - If there is any general repository problem.

PathNotFoundException - If there is no folder in the repository with this path.

LockException

DatabaseException

getVersionHistorySize

long getVersionHistorySize(String token,
                         String docPath)
                           throws RepositoryException,
                                  PathNotFoundException,
                                  DatabaseException

Get the version size of a Document.

Parameters:

docPath - The path that identifies an unique document.

Throws:

AccessDeniedException - If there is any security problem: you can't access this folder because of lack of permissions.

RepositoryException - If there is any general repository problem.

PathNotFoundException - If there is no folder in the repository with this path.

DatabaseException

isValid

boolean isValid(String token,
              String docId)
                throws PathNotFoundException,
                       RepositoryException,
                       DatabaseException

Test if a document path is valid.

Parameters:

docId - The path that identifies an unique document or its UUID.

Returns:

True if is a valid document path, otherwise false.

Throws:

PathNotFoundException - If the node does not exists.

RepositoryException - If there is any general repository problem.

DatabaseException

getPath

String getPath(String token,
             String uuid)
               throws AccessDeniedException,
                      RepositoryException,
                      DatabaseException

Get the document path from a UUID

Parameters:

uuid - The unique document id.

Returns:

The document path

Throws:

AccessDeniedException - If there is any security problem: you can't access this node because of lack of permissions.

RepositoryException - If there is any problem.

DatabaseException