DbDocumentModule (OpenKM Web Application 6.3.5 API)

java.lang.Object
- com.openkm.module.db.DbDocumentModule

All Implemented Interfaces:: DocumentModule

public class DbDocumentModule
extends Object
implements DocumentModule

Constructor Summary

Constructors
Constructor and Description

DbDocumentModule()

Constructors
Constructor and Description
`DbDocumentModule()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`cancelCheckout(String token, String docId)` Cancel a previous checked out state in a document.
`Version`	`checkin(String token, String docId, InputStream is, long size, String comment, String userId)` Used when big files and WebDAV
`Version`	`checkin(String token, String docId, InputStream is, long size, String comment, String userId, int increment)` Used when increase document major version
`Version`	`checkin(String token, String docId, InputStream is, String comment)` Check in the document to create a new version.
`Version`	`checkin(String token, String docId, InputStream is, String comment, int increment)` Check in the document to create a new version.
`Version`	`checkin(String token, String docId, InputStream is, String comment, String userId)` Used in Zoho extension
`void`	`checkout(String token, String docId)` Checkout the document to edit it.
`void`	`checkout(String token, String docId, String userId)` Used in Zoho extension
`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.
`Document`	`create(String token, Document doc, InputStream is, long size, String userId)` Used when big files and WebDAV and GoogleDocs
`Document`	`create(String token, Document doc, InputStream is, long size, String userId, Ref<FileUploadResponse> fuResponse)` Used when big files and FileUpload
`void`	`delete(String token, String docId)` Deletes a document from the repository.
`void`	`extendedCopy(String token, String docId, String dstId, String docName, ExtendedAttributes extAttr)` Copy a document to another location in the repository.
`void`	`forceCancelCheckout(String token, String docId)` Force to cancel a previous checked out state in a document.
`void`	`forceUnlock(String token, String docId)` For document unlock, so will be editable for other users.
`List<Document>`	`getChildren(String token, String fldId)` Retrieve a list of children documents from an existing folder.
`List<Document>`	`getChilds(String token, String fldId)` Deprecated.
`InputStream`	`getContent(String token, String docId, boolean checkout)` Obtain document content from the repository.
`InputStream`	`getContent(String token, String docId, boolean checkout, boolean extendedSecurity)` Retrieve the content input stream from a document
`InputStream`	`getContentByVersion(String token, String docId, String verName)` Obtain document content from the repository.
`LockInfo`	`getLockInfo(String token, String docId)` Returns a lock information.
`String`	`getPath(String token, String uuid)` Get the document path from a UUID
`Document`	`getProperties(String token, String docId)` Obtain document properties from the repository.
`List<Version>`	`getVersionHistory(String token, String docId)` Get the document version history.
`long`	`getVersionHistorySize(String token, String docId)` Get the version size of a Document.
`boolean`	`isCheckedOut(String token, String docId)` Test if a node has been already checked out.
`boolean`	`isLocked(String token, String docId)` Tell if a document is locked.
`boolean`	`isValid(String token, String docId)` Test if a document path is valid.
`void`	`liveEditCancelCheckout(String token, String docId)` Cancel checkout and delete temporal file.
`Version`	`liveEditCheckin(String token, String docId, String comment, int increment)` New version and delete temporal file.
`void`	`liveEditForceCancelCheckout(String token, String docId)` Cancel checkout and delete temporal file.
`void`	`liveEditSetContent(String token, String docId, InputStream is)` Create temporal file and set content.
`LockInfo`	`lock(String token, String docId)` Lock a document, so only is editable by the locker.
`void`	`move(String token, String docId, String dstId)` Move a document to another location in the repository.
`void`	`purge(String token, String docId)` Deletes definitively a document from the repository.
`void`	`purgeVersionHistory(String token, String docId)` Purge a Document version history, so delete all previous versions but last one.
`Document`	`rename(String token, String docId, String newName)` Rename a document in the repository.
`void`	`restoreVersion(String token, String docId, 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 docId)` Unlock a document, so will be editable for other users.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- DbDocumentModule
```
public DbDocumentModule()
```

Method Detail

create
```
public Document create(String token,
              Document doc,
              InputStream is)
                throws UnsupportedMimeTypeException,
                       FileSizeExceededException,
                       UserQuotaExceededException,
                       VirusDetectedException,
                       ItemExistsException,
                       PathNotFoundException,
                       AccessDeniedException,
                       RepositoryException,
                       IOException,
                       DatabaseException,
                       ExtensionException,
                       AutomationException
```
Description copied from interface: DocumentModule

Creates a new document in the repository.

Specified by:

create in interface DocumentModule

doc - A document object with the new document properties.

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.

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

PathNotFoundException - If the parent folder doesn't exist.

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

create

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

Used when big files and WebDAV and GoogleDocs

Throws:: UnsupportedMimeTypeException; FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; IOException; DatabaseException; ExtensionException; AutomationException

create

public Document create(String token,
              Document doc,
              InputStream is,
              long size,
              String userId,
              Ref<FileUploadResponse> fuResponse)
                throws UnsupportedMimeTypeException,
                       FileSizeExceededException,
                       UserQuotaExceededException,
                       VirusDetectedException,
                       ItemExistsException,
                       PathNotFoundException,
                       AccessDeniedException,
                       RepositoryException,
                       IOException,
                       DatabaseException,
                       ExtensionException,
                       AutomationException

Used when big files and FileUpload

Throws:: UnsupportedMimeTypeException; FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; IOException; DatabaseException; ExtensionException; AutomationException

delete
```
public void delete(String token,
          String docId)
            throws LockException,
                   PathNotFoundException,
                   AccessDeniedException,
                   AutomationException,
                   RepositoryException,
                   DatabaseException
```
Description copied from interface: DocumentModule

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

Specified by:

delete in interface DocumentModule

docId - 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.

AutomationException

DatabaseException

rename
```
public Document rename(String token,
              String docId,
              String newName)
                throws PathNotFoundException,
                       ItemExistsException,
                       AccessDeniedException,
                       AutomationException,
                       LockException,
                       RepositoryException,
                       DatabaseException
```
Description copied from interface: DocumentModule

Rename a document in the repository.

Specified by:

rename in interface DocumentModule

docId - 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.

AutomationException

LockException

DatabaseException

getProperties
```
public Document getProperties(String token,
                     String docId)
                       throws AccessDeniedException,
                              PathNotFoundException,
                              RepositoryException,
                              DatabaseException
```
Description copied from interface: DocumentModule

Obtain document properties from the repository.

Specified by:

getProperties in interface DocumentModule

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.

AccessDeniedException

DatabaseException

setProperties
```
public void setProperties(String token,
                 Document doc)
                   throws VersionException,
                          LockException,
                          PathNotFoundException,
                          AccessDeniedException,
                          RepositoryException,
                          DatabaseException
```
Description copied from interface: DocumentModule

Set document properties in the repository.

Specified by:

setProperties in interface DocumentModule

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
```
public InputStream getContent(String token,
                     String docId,
                     boolean checkout)
                       throws PathNotFoundException,
                              AccessDeniedException,
                              RepositoryException,
                              IOException,
                              DatabaseException
```
Description copied from interface: DocumentModule

Obtain document content from the repository.

Specified by:

getContent in interface DocumentModule

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

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

getContent

public InputStream getContent(String token,
                     String docId,
                     boolean checkout,
                     boolean extendedSecurity)
                       throws PathNotFoundException,
                              AccessDeniedException,
                              RepositoryException,
                              IOException,
                              DatabaseException

Retrieve the content input stream from a document

Parameters:: token - Authorization token.; docId - Path of the document to get the content or its UUID.; checkout - If the content is retrieved due to a checkout or not.; extendedSecurity - If the extended security DOWNLOAD permission should be evaluated. This is used to enable the document preview.
Throws:: PathNotFoundException; AccessDeniedException; RepositoryException; IOException; DatabaseException

getContentByVersion
```
public InputStream getContentByVersion(String token,
                              String docId,
                              String verName)
                                throws RepositoryException,
                                       AccessDeniedException,
                                       PathNotFoundException,
                                       IOException,
                                       DatabaseException
```
Description copied from interface: DocumentModule

Obtain document content from the repository.

Specified by:

getContentByVersion in interface DocumentModule

docId - The path that identifies an unique document or its UUID.
verName - The id of the version to get the content from.

Returns:
The content of the document file.

Throws:

RepositoryException - If there is any general repository problem.

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

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
public List<Document> getChilds(String token,
                                  String fldId)
                         throws AccessDeniedException,
                                PathNotFoundException,
                                RepositoryException,
                                DatabaseException

Deprecated.

Description copied from interface: DocumentModule

Retrieve a list of child documents from an existing folder.

Specified by:: getChilds in interface DocumentModule; fldId - The path that identifies an unique folder or its UUID.
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.; AccessDeniedException; DatabaseException

getChildren
```
public List<Document> getChildren(String token,
                         String fldId)
                           throws AccessDeniedException,
                                  PathNotFoundException,
                                  RepositoryException,
                                  DatabaseException
```
Description copied from interface: DocumentModule

Retrieve a list of children documents from an existing folder.

Specified by:

getChildren in interface DocumentModule

fldId - The path that identifies an unique folder or its UUID.

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.

AccessDeniedException

DatabaseException

checkout
```
public void checkout(String token,
            String docId)
              throws LockException,
                     PathNotFoundException,
                     AccessDeniedException,
                     RepositoryException,
                     DatabaseException
```
Description copied from interface: DocumentModule

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.

Specified by:

checkout in interface DocumentModule

docId - 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

checkout

public void checkout(String token,
            String docId,
            String userId)
              throws LockException,
                     PathNotFoundException,
                     AccessDeniedException,
                     RepositoryException,
                     DatabaseException

Used in Zoho extension

Throws:: LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException

cancelCheckout
```
public void cancelCheckout(String token,
                  String docId)
                    throws LockException,
                           PathNotFoundException,
                           AccessDeniedException,
                           RepositoryException,
                           DatabaseException
```
Description copied from interface: DocumentModule

Cancel a previous checked out state in a document.

Specified by:

cancelCheckout in interface DocumentModule

docId - 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

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

Description copied from interface: DocumentModule

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

Specified by:: forceCancelCheckout in interface DocumentModule; docId - 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
```
public boolean isCheckedOut(String token,
                   String docId)
                     throws AccessDeniedException,
                            PathNotFoundException,
                            RepositoryException,
                            DatabaseException
```
Description copied from interface: DocumentModule

Test if a node has been already checked out.

Specified by:

isCheckedOut in interface DocumentModule

docId - 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.

AccessDeniedException

DatabaseException

checkin

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

Description copied from interface: DocumentModule

Check in the document to create a new version.

Specified by:: checkin in interface DocumentModule; docId - 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:: 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.; PathNotFoundException - If there is no document in this repository path.; LockException - A locked document can't be modified.; VersionException - If the nodes was not previously checked out.; FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; IOException; DatabaseException; AutomationException

checkin

public Version checkin(String token,
              String docId,
              InputStream is,
              String comment,
              int increment)
                throws FileSizeExceededException,
                       UserQuotaExceededException,
                       VirusDetectedException,
                       AccessDeniedException,
                       RepositoryException,
                       PathNotFoundException,
                       LockException,
                       VersionException,
                       IOException,
                       DatabaseException,
                       AutomationException

Description copied from interface: DocumentModule

Check in the document to create a new version.

Specified by:: checkin in interface DocumentModule; docId - The path that identifies an unique document.; comment - A comment for this checkin.; increment - Which increment should be increased.
Returns:: A version object with the properties of the new generated version.
Throws:: 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.; PathNotFoundException - If there is no document in this repository path.; LockException - A locked document can't be modified.; VersionException - If the nodes was not previously checked out.; FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; IOException; DatabaseException; AutomationException

checkin

public Version checkin(String token,
              String docId,
              InputStream is,
              String comment,
              String userId)
                throws FileSizeExceededException,
                       UserQuotaExceededException,
                       VirusDetectedException,
                       AccessDeniedException,
                       RepositoryException,
                       PathNotFoundException,
                       LockException,
                       VersionException,
                       IOException,
                       DatabaseException,
                       AutomationException

Used in Zoho extension

Throws:: FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; AccessDeniedException; RepositoryException; PathNotFoundException; LockException; VersionException; IOException; DatabaseException; AutomationException

checkin

public Version checkin(String token,
              String docId,
              InputStream is,
              long size,
              String comment,
              String userId)
                throws FileSizeExceededException,
                       UserQuotaExceededException,
                       VirusDetectedException,
                       AccessDeniedException,
                       RepositoryException,
                       PathNotFoundException,
                       LockException,
                       VersionException,
                       IOException,
                       DatabaseException,
                       AutomationException

Used when big files and WebDAV

Throws:: FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; AccessDeniedException; RepositoryException; PathNotFoundException; LockException; VersionException; IOException; DatabaseException; AutomationException

checkin

public Version checkin(String token,
              String docId,
              InputStream is,
              long size,
              String comment,
              String userId,
              int increment)
                throws FileSizeExceededException,
                       UserQuotaExceededException,
                       VirusDetectedException,
                       AccessDeniedException,
                       RepositoryException,
                       PathNotFoundException,
                       LockException,
                       VersionException,
                       IOException,
                       DatabaseException,
                       AutomationException

Used when increase document major version

Throws:: FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; AccessDeniedException; RepositoryException; PathNotFoundException; LockException; VersionException; IOException; DatabaseException; AutomationException

lock
```
public LockInfo lock(String token,
            String docId)
              throws LockException,
                     PathNotFoundException,
                     AccessDeniedException,
                     RepositoryException,
                     DatabaseException
```
Description copied from interface: DocumentModule

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

Specified by:

lock in interface DocumentModule

docId - 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
```
public void unlock(String token,
          String docId)
            throws LockException,
                   PathNotFoundException,
                   AccessDeniedException,
                   RepositoryException,
                   DatabaseException
```
Description copied from interface: DocumentModule

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

Specified by:

unlock in interface DocumentModule

docId - 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
```
public void forceUnlock(String token,
               String docId)
                 throws LockException,
                        PathNotFoundException,
                        AccessDeniedException,
                        RepositoryException,
                        DatabaseException,
                        PrincipalAdapterException
```
Description copied from interface: DocumentModule

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

Specified by:

forceUnlock in interface DocumentModule

docId - 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
```
public boolean isLocked(String token,
               String docId)
                 throws RepositoryException,
                        AccessDeniedException,
                        PathNotFoundException,
                        DatabaseException
```
Description copied from interface: DocumentModule

Tell if a document is locked.

Specified by:

isLocked in interface DocumentModule

docId - The path that identifies an unique document.

Returns:
True if the document is locked, and False otherwise.

Throws:

RepositoryException - If there is any repository problem.

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

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

DatabaseException

getLockInfo
```
public LockInfo getLockInfo(String token,
                   String docId)
                     throws RepositoryException,
                            AccessDeniedException,
                            PathNotFoundException,
                            LockException,
                            DatabaseException
```
Description copied from interface: DocumentModule

Returns a lock information.

Specified by:

getLockInfo in interface DocumentModule

docId - The path that identifies an unique document.

Returns:
The lock info.

Throws:

RepositoryException - If there is any repository problem.

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

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

LockException - If the node is not locked.

DatabaseException

purge
```
public void purge(String token,
         String docId)
           throws LockException,
                  AccessDeniedException,
                  RepositoryException,
                  PathNotFoundException,
                  DatabaseException
```
Description copied from interface: DocumentModule

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

Specified by:

purge in interface DocumentModule

docId - 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

move
```
public void move(String token,
        String docId,
        String dstId)
          throws PathNotFoundException,
                 ItemExistsException,
                 AccessDeniedException,
                 LockException,
                 RepositoryException,
                 DatabaseException,
                 ExtensionException,
                 AutomationException
```
Description copied from interface: DocumentModule

Move a document to another location in the repository.

Specified by:

move in interface DocumentModule

docId - The path that identifies an unique document.
dstId - 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
```
public void copy(String token,
        String docPath,
        String dstPath)
          throws ItemExistsException,
                 PathNotFoundException,
                 AccessDeniedException,
                 RepositoryException,
                 IOException,
                 AutomationException,
                 DatabaseException,
                 UserQuotaExceededException
```
Description copied from interface: DocumentModule

Copy a document to another location in the repository.

Specified by:

copy in interface DocumentModule

docPath - The path that identifies an unique document.
dstPath - The destination folder path.

Throws:

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

PathNotFoundException - If the dstPath does not exists

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

AutomationException

DatabaseException

UserQuotaExceededException

extendedCopy
```
public void extendedCopy(String token,
                String docId,
                String dstId,
                String docName,
                ExtendedAttributes extAttr)
                  throws ItemExistsException,
                         PathNotFoundException,
                         AccessDeniedException,
                         RepositoryException,
                         IOException,
                         AutomationException,
                         DatabaseException,
                         UserQuotaExceededException
```
Description copied from interface: DocumentModule

Copy a document to another location in the repository.

Specified by:

extendedCopy in interface DocumentModule

docId - The path that identifies an unique document.
dstId - The destination folder path.
docName - The name of the new document or null if not changed
extAttr - Attributes to define what need to be duplicated.

Throws:

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

PathNotFoundException - If the dstPath does not exists

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

AutomationException

DatabaseException

UserQuotaExceededException

restoreVersion
```
public void restoreVersion(String token,
                  String docId,
                  String versionId)
                    throws PathNotFoundException,
                           AccessDeniedException,
                           LockException,
                           RepositoryException,
                           DatabaseException
```
Description copied from interface: DocumentModule

Revert the document to an specific previous version.

Specified by:

restoreVersion in interface DocumentModule

docId - 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

purgeVersionHistory
```
public void purgeVersionHistory(String token,
                       String docId)
                         throws AccessDeniedException,
                                PathNotFoundException,
                                LockException,
                                RepositoryException,
                                DatabaseException
```
Description copied from interface: DocumentModule

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

Specified by:

purgeVersionHistory in interface DocumentModule

docId - 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.

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

RepositoryException - If there is any general repository problem.

LockException

DatabaseException

getVersionHistory

public List<Version> getVersionHistory(String token,
                              String docId)
                                throws AccessDeniedException,
                                       PathNotFoundException,
                                       RepositoryException,
                                       DatabaseException

Description copied from interface: DocumentModule

Get the document version history.

Specified by:: getVersionHistory in interface DocumentModule; docId - The path that identifies an unique document or its UUID.
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.; AccessDeniedException; DatabaseException

getVersionHistorySize
```
public long getVersionHistorySize(String token,
                         String docId)
                           throws RepositoryException,
                                  AccessDeniedException,
                                  PathNotFoundException,
                                  DatabaseException
```
Description copied from interface: DocumentModule

Get the version size of a Document.

Specified by:

getVersionHistorySize in interface DocumentModule

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

Throws:

RepositoryException - If there is any general repository problem.

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

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

DatabaseException

isValid
```
public boolean isValid(String token,
              String docId)
                throws AccessDeniedException,
                       PathNotFoundException,
                       RepositoryException,
                       DatabaseException
```
Description copied from interface: DocumentModule

Test if a document path is valid.

Specified by:

isValid in interface DocumentModule

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.

AccessDeniedException

DatabaseException

getPath
```
public String getPath(String token,
             String uuid)
               throws AccessDeniedException,
                      RepositoryException,
                      DatabaseException
```
Description copied from interface: DocumentModule

Get the document path from a UUID

Specified by:

getPath in interface DocumentModule

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

liveEditSetContent

public void liveEditSetContent(String token,
                      String docId,
                      InputStream is)
                        throws FileSizeExceededException,
                               UserQuotaExceededException,
                               VirusDetectedException,
                               AccessDeniedException,
                               RepositoryException,
                               PathNotFoundException,
                               LockException,
                               VersionException,
                               IOException,
                               DatabaseException

Create temporal file and set content.

Throws:: FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; AccessDeniedException; RepositoryException; PathNotFoundException; LockException; VersionException; IOException; DatabaseException

liveEditCheckin

public Version liveEditCheckin(String token,
                      String docId,
                      String comment,
                      int increment)
                        throws FileSizeExceededException,
                               UserQuotaExceededException,
                               VirusDetectedException,
                               AccessDeniedException,
                               RepositoryException,
                               PathNotFoundException,
                               LockException,
                               VersionException,
                               IOException,
                               DatabaseException,
                               AutomationException

New version and delete temporal file.

Throws:: FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; AccessDeniedException; RepositoryException; PathNotFoundException; LockException; VersionException; IOException; DatabaseException; AutomationException

liveEditCancelCheckout

public void liveEditCancelCheckout(String token,
                          String docId)
                            throws LockException,
                                   PathNotFoundException,
                                   AccessDeniedException,
                                   RepositoryException,
                                   DatabaseException

Cancel checkout and delete temporal file.

Throws:: LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException

liveEditForceCancelCheckout

public void liveEditForceCancelCheckout(String token,
                               String docId)
                                 throws LockException,
                                        PathNotFoundException,
                                        AccessDeniedException,
                                        RepositoryException,
                                        DatabaseException

Cancel checkout and delete temporal file.

Throws:: LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException

Class DbDocumentModule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DbDocumentModule

Method Detail

create

create

create

delete

rename

getProperties

setProperties

getContent

getContent

getContentByVersion

getChilds

getChildren

checkout

checkout

cancelCheckout

forceCancelCheckout

isCheckedOut

checkin

checkin

checkin

checkin

checkin

lock

unlock

forceUnlock

isLocked

getLockInfo

purge

move

copy

extendedCopy

restoreVersion

purgeVersionHistory

getVersionHistory

getVersionHistorySize

isValid

getPath

liveEditSetContent

liveEditCheckin

liveEditCancelCheckout

liveEditForceCancelCheckout