DocumentImpl (OpenKM SDK for Java 2.0-ce API)

java.lang.Object
- com.openkm.sdk4j.impl.ClientImpl
- - com.openkm.sdk4j.impl.DocumentImpl

All Implemented Interfaces:

BaseDocument, Serializable
```
public class DocumentImpl
extends ClientImpl
implements BaseDocument, Serializable
```
DocumentImpl

Author:

jllort

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

DocumentImpl(String host)
DocumentImpl

Constructors
Constructor and Description
`DocumentImpl(String host)` DocumentImpl

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`cancelCheckout(String uuid)` Cancel a previous checked out state in a document.
`Version`	`checkin(String uuid, InputStream is, String comment)` Check in the document to create a new version.
`Version`	`checkin(String uuid, InputStream is, String comment, int increment)` Check in the document to create a new version.
`void`	`checkout(String uuid)` Checkout the document to edit it.
`Document`	`copyDocument(String uuid, String dstId, String newName)` Copy a document to another location in the repository.
`Document`	`createDocument(String uuid, File file)` Creates a new document
`Document`	`createDocument(String uuid, String name, InputStream is)` Creates a new document
`Document`	`createDocument(String uuid, String name, InputStream is, long nodeClass)` Creates a new document
`Document`	`createDocumentFromTemplate(String uuid, String dstPath, boolean categories, boolean keywords, boolean notes, boolean security, Map<String,String> properties)` Create document from template document.
`WizardNode`	`createWizardDocument(String uuid, String name, long nodeClass, InputStream is)` Create a new document with wizard.
`void`	`deleteDocument(String uuid)` Deletes a document from the repository.
`Document`	`extendedDocumentCopy(String uuid, String dstId, String name, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean security)` Copy a document to another location in the repository.
`void`	`forceCancelCheckout(String uuid)` Force to cancel a previous checked out state in a document.
`List<Document>`	`getCheckedOut()` Get checked out documents
`InputStream`	`getContent(String uuid)` Obtain document content from the repository.
`InputStream`	`getContentByVersion(String uuid, String versionName)` Obtain document content from the repository.
`List<String>`	`getDetectedLanguages()` Retrieve a list of language.
`List<Document>`	`getDocumentChildren(String uuid)` Retrieve a list of children documents from an existing folder.
`String`	`getDocumentPath(String uuid)` Get the document path from a UUID
`InputStream`	`getDocumentPdf(String uuid)` PDF of the document.
`Document`	`getDocumentProperties(String uuid)` Obtain document properties from the repository.
`String`	`getExtractedText(String uuid)` Obtain the document extracted text.
`LockInfo`	`getLockInfo(String uuid)` Deprecated. As of sdk4j 3.11, replaced by `NodeImpl.getLockInfo(String)`
`int`	`getNumberOfPages(String uuid)` Get the number of pages of a document.
`String`	`getPageAsImage(String uuid, int pageNumber, int maxWidth, int maxHeight)` Get page as image.
`InputStream`	`getThumbnail(String uuid, ThumbnailType type)` Returns thumbnail image data.
`long`	`getVersionHistorySize(String uuid)` Get the versions size of a Document.
`boolean`	`isAttachment(String uuid)` Indicates if the node is a mail attachment or not.
`boolean`	`isCheckedOut(String uuid)` Test if a node has been already checked out.
`boolean`	`isLocked(String uuid)` Deprecated. As of sdk4j 3.11, replaced by `NodeImpl.isLocked(String)`
`boolean`	`isValidDocument(String uuid)` Test if a document path exists and is readable.
`void`	`moveDocument(String uuid, String dstId)` Move a document to another location in the repository.
`void`	`purgeDocument(String uuid)` Deletes definitively a document from the repository.
`Document`	`renameDocument(String uuid, String newName)` Rename a document in the repository.
`void`	`setAuthorizationToken(String authorizationToken)` setAuthenticationToken
`void`	`setDocumentDescription(String uuid, String description)` Set document description.
`void`	`setDocumentTitle(String uuid, String title)` Set document title.
`void`	`setExtractedText(String uuid, InputStream is)` Sets extracted text.
`void`	`setLanguage(String uuid, String lang)` Set document language.
`void`	`setProperties(String uuid, String title, String description, String lang, List<String> keywords, List<String> categories)` Set document properties in the repository.
`void`	`updateDocumentFromTemplate(String uuid, String dstId, Map<String,String> properties)` Update from template

Methods inherited from class com.openkm.sdk4j.impl.ClientImpl
getClient, resource, resource, resource

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

Constructor Detail
- DocumentImpl
```
public DocumentImpl(String host)
```
  DocumentImpl

Method Detail

setAuthorizationToken

public void setAuthorizationToken(String authorizationToken)

setAuthenticationToken

createDocument

public Document createDocument(String uuid,
                               File file)
                        throws UnsupportedMimeTypeException,
                               FileSizeExceededException,
                               UserQuotaExceededException,
                               VirusDetectedException,
                               ItemExistsException,
                               PathNotFoundException,
                               AccessDeniedException,
                               RepositoryException,
                               DatabaseException,
                               ExtensionException,
                               AutomationException,
                               PromotedAsRecordLockException,
                               UnknownException,
                               WebserviceException

Description copied from interface: BaseDocument

Creates a new document

Specified by:: createDocument in interface BaseDocument
Parameters:: uuid - Node uuid.; file - The document content in bytes.
Returns:: Document Return an object Document with the properties of the created document.
Throws:: UnsupportedMimeTypeException - the unsupported mime type exception; FileSizeExceededException - the file size exceeded exception; UserQuotaExceededException - the user quota exceeded exception; VirusDetectedException - the virus detected exception; ItemExistsException - the item exists exception; PathNotFoundException - the path not found exception; AccessDeniedException - the access denied exception; RepositoryException - the repository exception; DatabaseException - the database exception; ExtensionException - the extension exception; AutomationException - the automation exception; PromotedAsRecordLockException - the promoted as record lock exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

createDocument

public Document createDocument(String uuid,
                               String name,
                               InputStream is)
                        throws UnsupportedMimeTypeException,
                               FileSizeExceededException,
                               UserQuotaExceededException,
                               VirusDetectedException,
                               ItemExistsException,
                               PathNotFoundException,
                               AccessDeniedException,
                               RepositoryException,
                               DatabaseException,
                               ExtensionException,
                               AutomationException,
                               PromotedAsRecordLockException,
                               UnknownException,
                               WebserviceException

Description copied from interface: BaseDocument

Creates a new document

Specified by:: createDocument in interface BaseDocument
Parameters:: uuid - Node uuid.; name - The nane document; is - The document content in bytes.
Returns:: Document Return an object Document with the properties of the created document.
Throws:: UnsupportedMimeTypeException - the unsupported mime type exception; FileSizeExceededException - the file size exceeded exception; UserQuotaExceededException - the user quota exceeded exception; VirusDetectedException - the virus detected exception; ItemExistsException - the item exists exception; PathNotFoundException - the path not found exception; AccessDeniedException - the access denied exception; RepositoryException - the repository exception; DatabaseException - the database exception; ExtensionException - the extension exception; AutomationException - the automation exception; PromotedAsRecordLockException - the promoted as record lock exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

createDocument

public Document createDocument(String uuid,
                               String name,
                               InputStream is,
                               long nodeClass)
                        throws UnsupportedMimeTypeException,
                               FileSizeExceededException,
                               UserQuotaExceededException,
                               VirusDetectedException,
                               ItemExistsException,
                               PathNotFoundException,
                               AccessDeniedException,
                               RepositoryException,
                               DatabaseException,
                               ExtensionException,
                               AutomationException,
                               PromotedAsRecordLockException,
                               UnknownException,
                               WebserviceException

Description copied from interface: BaseDocument

Creates a new document

Specified by:: createDocument in interface BaseDocument
Parameters:: uuid - Node uuid.; name - The name document; is - The document content in bytes.; nodeClass - the node class
Returns:: Document Return an object Document with the properties of the created document.
Throws:: UnsupportedMimeTypeException - the unsupported mime type exception; FileSizeExceededException - the file size exceeded exception; UserQuotaExceededException - the user quota exceeded exception; VirusDetectedException - the virus detected exception; ItemExistsException - the item exists exception; PathNotFoundException - the path not found exception; AccessDeniedException - the access denied exception; RepositoryException - the repository exception; DatabaseException - the database exception; ExtensionException - the extension exception; AutomationException - the automation exception; PromotedAsRecordLockException - the promoted as record lock exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

deleteDocument

public void deleteDocument(String uuid)
                    throws AutomationException,
                           AccessDeniedException,
                           RepositoryException,
                           PathNotFoundException,
                           LockException,
                           DatabaseException,
                           ExtensionException,
                           PromotedAsRecordLockException,
                           UnknownException,
                           WebserviceException

Description copied from interface: BaseDocument

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:: deleteDocument in interface BaseDocument
Parameters:: uuid - Node uuid
Throws:: AutomationException - the automation exception; AccessDeniedException - the access denied exception; RepositoryException - the repository exception; PathNotFoundException - the path not found exception; LockException - the lock exception; DatabaseException - the database exception; ExtensionException - the extension exception; PromotedAsRecordLockException - the promoted as record lock exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

getDocumentProperties

public Document getDocumentProperties(String uuid)
                               throws AccessDeniedException,
                                      RepositoryException,
                                      PathNotFoundException,
                                      DatabaseException,
                                      UnknownException,
                                      WebserviceException

Description copied from interface: BaseDocument

Obtain document properties from the repository.

Specified by:: getDocumentProperties in interface BaseDocument
Parameters:: uuid - Node uuid
Returns:: Document The document properties.
Throws:: AccessDeniedException - the access denied exception; RepositoryException - the repository exception; PathNotFoundException - the path not found exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

getContent

public InputStream getContent(String uuid)
                       throws RepositoryException,
                              PathNotFoundException,
                              AccessDeniedException,
                              DatabaseException,
                              UnknownException,
                              WebserviceException

Description copied from interface: BaseDocument

Obtain document content from the repository.

Specified by:: getContent in interface BaseDocument
Parameters:: uuid - Node uuid
Returns:: InputStream The content of the document file.
Throws:: RepositoryException - the repository exception; PathNotFoundException - the path not found exception; AccessDeniedException - the access denied exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

getContentByVersion

public InputStream getContentByVersion(String uuid,
                                       String versionName)
                                throws RepositoryException,
                                       PathNotFoundException,
                                       AccessDeniedException,
                                       DatabaseException,
                                       UnknownException,
                                       WebserviceException

Description copied from interface: BaseDocument

Obtain document content from the repository.

Specified by:: getContentByVersion in interface BaseDocument
Parameters:: uuid - Node uuid; versionName - The name of the version to get the content from.
Returns:: InputStream The content of the document file.
Throws:: RepositoryException - the repository exception; PathNotFoundException - the path not found exception; AccessDeniedException - the access denied exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

getDocumentChildren

public List<Document> getDocumentChildren(String uuid)
                                   throws AccessDeniedException,
                                          RepositoryException,
                                          PathNotFoundException,
                                          DatabaseException,
                                          UnknownException,
                                          WebserviceException

Description copied from interface: BaseDocument

Retrieve a list of children documents from an existing folder.

Specified by:: getDocumentChildren in interface BaseDocument
Parameters:: uuid - Node uuid
Returns:: List A Collection with the child documents.
Throws:: AccessDeniedException - the access denied exception; RepositoryException - the repository exception; PathNotFoundException - the path not found exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

renameDocument

public Document renameDocument(String uuid,
                               String newName)
                        throws AccessDeniedException,
                               RepositoryException,
                               PathNotFoundException,
                               ItemExistsException,
                               LockException,
                               DatabaseException,
                               ExtensionException,
                               PromotedAsRecordLockException,
                               AutomationException,
                               UnknownException,
                               WebserviceException

Description copied from interface: BaseDocument

Rename a document in the repository.

Specified by:: renameDocument in interface BaseDocument
Parameters:: uuid - Node uuid; newName - The new document name.
Returns:: Document An document object with the new document properties.
Throws:: AccessDeniedException - the access denied exception; RepositoryException - the repository exception; PathNotFoundException - the path not found exception; ItemExistsException - the item exists exception; LockException - the lock exception; DatabaseException - the database exception; ExtensionException - the extension exception; PromotedAsRecordLockException - the promoted as record lock exception; AutomationException - the automation exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

setProperties

public void setProperties(String uuid,
                          String title,
                          String description,
                          String lang,
                          List<String> keywords,
                          List<String> categories)
                   throws AccessDeniedException,
                          RepositoryException,
                          PathNotFoundException,
                          VersionException,
                          LockException,
                          DatabaseException,
                          PromotedAsRecordLockException,
                          UnknownException,
                          WebserviceException

Description copied from interface: BaseDocument

Set document properties in the repository.

Specified by:: setProperties in interface BaseDocument
Parameters:: uuid - Node uuid; title - the title; description - the description; lang - the lang; keywords - the keywords; categories - the categories
Throws:: AccessDeniedException - the access denied exception; RepositoryException - the repository exception; PathNotFoundException - the path not found exception; VersionException - the version exception; LockException - the lock exception; DatabaseException - the database exception; PromotedAsRecordLockException - the promoted as record lock exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

setLanguage

public void setLanguage(String uuid,
                        String lang)
                 throws VersionException,
                        LockException,
                        PathNotFoundException,
                        AccessDeniedException,
                        RepositoryException,
                        DatabaseException,
                        PromotedAsRecordLockException,
                        UnknownException,
                        WebserviceException

Description copied from interface: BaseDocument

Set document language.

Specified by:: setLanguage in interface BaseDocument
Parameters:: uuid - Node uuid; lang - The language
Throws:: VersionException - the version exception; LockException - the lock exception; PathNotFoundException - the path not found exception; AccessDeniedException - the access denied exception; RepositoryException - the repository exception; DatabaseException - the database exception; PromotedAsRecordLockException - the promoted as record lock exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

setDocumentTitle

public void setDocumentTitle(String uuid,
                             String title)
                      throws VersionException,
                             LockException,
                             PathNotFoundException,
                             AccessDeniedException,
                             RepositoryException,
                             DatabaseException,
                             PromotedAsRecordLockException,
                             UnknownException,
                             WebserviceException

Description copied from interface: BaseDocument

Set document title.

Specified by:: setDocumentTitle in interface BaseDocument
Parameters:: uuid - Node uuid; title - The title
Throws:: VersionException - the version exception; LockException - the lock exception; PathNotFoundException - the path not found exception; AccessDeniedException - the access denied exception; RepositoryException - the repository exception; DatabaseException - the database exception; PromotedAsRecordLockException - the promoted as record lock exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

checkout
```
public void checkout(String uuid)
              throws AccessDeniedException,
                     RepositoryException,
                     PathNotFoundException,
                     LockException,
                     DatabaseException,
                     UnknownException,
                     WebserviceException
```
Description copied from interface: BaseDocument

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 BaseDocument

Parameters:

uuid - Node uuid

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

LockException - the lock exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

cancelCheckout

public void cancelCheckout(String uuid)
                    throws AccessDeniedException,
                           RepositoryException,
                           PathNotFoundException,
                           LockException,
                           DatabaseException,
                           UnknownException,
                           WebserviceException

Description copied from interface: BaseDocument

Cancel a previous checked out state in a document.

Specified by:: cancelCheckout in interface BaseDocument
Parameters:: uuid - Node uuid
Throws:: AccessDeniedException - the access denied exception; RepositoryException - the repository exception; PathNotFoundException - the path not found exception; LockException - the lock exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

forceCancelCheckout

public void forceCancelCheckout(String uuid)
                         throws AccessDeniedException,
                                RepositoryException,
                                PathNotFoundException,
                                LockException,
                                DatabaseException,
                                PrincipalAdapterException,
                                UnknownException,
                                WebserviceException

Description copied from interface: BaseDocument

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

Specified by:: forceCancelCheckout in interface BaseDocument
Parameters:: uuid - Node uuid
Throws:: AccessDeniedException - the access denied exception; RepositoryException - the repository exception; PathNotFoundException - the path not found exception; LockException - the lock exception; DatabaseException - the database exception; PrincipalAdapterException - the principal adapter exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

isCheckedOut
```
public boolean isCheckedOut(String uuid)
                     throws AccessDeniedException,
                            PathNotFoundException,
                            RepositoryException,
                            DatabaseException,
                            UnknownException,
                            WebserviceException
```
Description copied from interface: BaseDocument

Test if a node has been already checked out.

Specified by:

isCheckedOut in interface BaseDocument

Parameters:

uuid - Node uuid

Returns:

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

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

checkin

public Version checkin(String uuid,
                       InputStream is,
                       String comment)
                throws FileSizeExceededException,
                       UserQuotaExceededException,
                       VirusDetectedException,
                       LockException,
                       PathNotFoundException,
                       AccessDeniedException,
                       RepositoryException,
                       DatabaseException,
                       ExtensionException,
                       AutomationException,
                       PromotedAsRecordLockException,
                       UnknownException,
                       WebserviceException

Description copied from interface: BaseDocument

Check in the document to create a new version.

Specified by:: checkin in interface BaseDocument
Parameters:: uuid - Node uuid; is - The document content in bytes.; comment - A comment for this checkin.
Returns:: Version A version object with the properties of the new generated version.
Throws:: FileSizeExceededException - the file size exceeded exception; UserQuotaExceededException - the user quota exceeded exception; VirusDetectedException - the virus detected exception; LockException - the lock exception; PathNotFoundException - the path not found exception; AccessDeniedException - the access denied exception; RepositoryException - the repository exception; DatabaseException - the database exception; ExtensionException - the extension exception; AutomationException - the automation exception; PromotedAsRecordLockException - the promoted as record lock exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

checkin

public Version checkin(String uuid,
                       InputStream is,
                       String comment,
                       int increment)
                throws FileSizeExceededException,
                       UserQuotaExceededException,
                       VirusDetectedException,
                       LockException,
                       PathNotFoundException,
                       AccessDeniedException,
                       RepositoryException,
                       DatabaseException,
                       ExtensionException,
                       AutomationException,
                       PromotedAsRecordLockException,
                       UnknownException,
                       WebserviceException

Description copied from interface: BaseDocument

Check in the document to create a new version.

Specified by:: checkin in interface BaseDocument
Parameters:: uuid - Node uuid; is - The document content in bytes.; comment - A comment for this checkin.; increment - Which increment should be increased.
Returns:: Version A version object with the properties of the new generated version.
Throws:: FileSizeExceededException - the file size exceeded exception; UserQuotaExceededException - the user quota exceeded exception; VirusDetectedException - the virus detected exception; LockException - the lock exception; PathNotFoundException - the path not found exception; AccessDeniedException - the access denied exception; RepositoryException - the repository exception; DatabaseException - the database exception; ExtensionException - the extension exception; AutomationException - the automation exception; PromotedAsRecordLockException - the promoted as record lock exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

isLocked

@Deprecated
public boolean isLocked(String uuid)
                             throws AccessDeniedException,
                                    RepositoryException,
                                    PathNotFoundException,
                                    DatabaseException,
                                    UnknownException,
                                    WebserviceException

Deprecated. As of sdk4j 3.11, replaced by NodeImpl.isLocked(String)

Tell if a node is locked.

Specified by:: isLocked in interface BaseDocument
Parameters:: uuid - Node uuid
Returns:: True if the node is locked, and False otherwise.
Throws:: AccessDeniedException - the access denied exception; RepositoryException - the repository exception; PathNotFoundException - the path not found exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception
See Also:: NodeImpl.isLocked(String)

getLockInfo

@Deprecated
public LockInfo getLockInfo(String uuid)
                                 throws AccessDeniedException,
                                        RepositoryException,
                                        PathNotFoundException,
                                        LockException,
                                        DatabaseException,
                                        UnknownException,
                                        WebserviceException

Deprecated. As of sdk4j 3.11, replaced by NodeImpl.getLockInfo(String)

Returns a lock information.

Specified by:: getLockInfo in interface BaseDocument
Parameters:: uuid - Node uuid
Returns:: The lock info.
Throws:: AccessDeniedException - the access denied exception; RepositoryException - the repository exception; PathNotFoundException - the path not found exception; LockException - the lock exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception
See Also:: NodeImpl.getLockInfo(String)

purgeDocument

public void purgeDocument(String uuid)
                   throws LockException,
                          AccessDeniedException,
                          RepositoryException,
                          PathNotFoundException,
                          DatabaseException,
                          ExtensionException,
                          PromotedAsRecordLockException,
                          UnknownException,
                          WebserviceException

Description copied from interface: BaseDocument

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

Specified by:: purgeDocument in interface BaseDocument
Parameters:: uuid - Node uuid
Throws:: LockException - the lock exception; AccessDeniedException - the access denied exception; RepositoryException - the repository exception; PathNotFoundException - the path not found exception; DatabaseException - the database exception; ExtensionException - the extension exception; PromotedAsRecordLockException - the promoted as record lock exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

moveDocument

public void moveDocument(String uuid,
                         String dstId)
                  throws LockException,
                         PathNotFoundException,
                         ItemExistsException,
                         AccessDeniedException,
                         RepositoryException,
                         DatabaseException,
                         ExtensionException,
                         PromotedAsRecordLockException,
                         AutomationException,
                         FilePlanCatalogManagerException,
                         VersionException,
                         UnknownException,
                         WebserviceException

Description copied from interface: BaseDocument

Move a document to another location in the repository.

Specified by:: moveDocument in interface BaseDocument
Parameters:: uuid - Node uuid; dstId - The destination folder path or its UUID.
Throws:: LockException - the lock exception; PathNotFoundException - the path not found exception; ItemExistsException - the item exists exception; AccessDeniedException - the access denied exception; RepositoryException - the repository exception; DatabaseException - the database exception; ExtensionException - the extension exception; PromotedAsRecordLockException - the promoted as record lock exception; AutomationException - the automation exception; FilePlanCatalogManagerException - the file plan catalog manager exception; VersionException - the version exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

copyDocument

public Document copyDocument(String uuid,
                             String dstId,
                             String newName)
                      throws ItemExistsException,
                             PathNotFoundException,
                             AccessDeniedException,
                             RepositoryException,
                             DatabaseException,
                             ExtensionException,
                             AutomationException,
                             PromotedAsRecordLockException,
                             UnknownException,
                             WebserviceException

Description copied from interface: BaseDocument

Copy a document to another location in the repository.

Specified by:: copyDocument in interface BaseDocument
Parameters:: uuid - Node uuid; dstId - The destination folder path or its UUID.; newName - The new name to the document
Returns:: Document An object document
Throws:: ItemExistsException - the item exists exception; PathNotFoundException - the path not found exception; AccessDeniedException - the access denied exception; RepositoryException - the repository exception; DatabaseException - the database exception; ExtensionException - the extension exception; AutomationException - the automation exception; PromotedAsRecordLockException - the promoted as record lock exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

getVersionHistorySize

public long getVersionHistorySize(String uuid)
                           throws AccessDeniedException,
                                  RepositoryException,
                                  PathNotFoundException,
                                  DatabaseException,
                                  UnknownException,
                                  WebserviceException

Description copied from interface: BaseDocument

Get the versions size of a Document.

Specified by:: getVersionHistorySize in interface BaseDocument
Parameters:: uuid - Node uuid
Returns:: long The version size of a Document.
Throws:: AccessDeniedException - the access denied exception; RepositoryException - the repository exception; PathNotFoundException - the path not found exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

isValidDocument
```
public boolean isValidDocument(String uuid)
                        throws PathNotFoundException,
                               AccessDeniedException,
                               RepositoryException,
                               DatabaseException,
                               UnknownException,
                               WebserviceException
```
Description copied from interface: BaseDocument

Test if a document path exists and is readable.

Specified by:

isValidDocument in interface BaseDocument

Parameters:

uuid - Node uuid

Returns:

True if is a valid document path, otherwise false.

Throws:

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getDocumentPath

public String getDocumentPath(String uuid)
                       throws AccessDeniedException,
                              RepositoryException,
                              DatabaseException,
                              UnknownException,
                              WebserviceException

Description copied from interface: BaseDocument

Get the document path from a UUID

Specified by:: getDocumentPath in interface BaseDocument
Parameters:: uuid - Node uuid
Returns:: The document path
Throws:: AccessDeniedException - the access denied exception; RepositoryException - the repository exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

getDetectedLanguages

public List<String> getDetectedLanguages()
                                  throws AccessDeniedException,
                                         RepositoryException,
                                         DatabaseException,
                                         UnknownException,
                                         WebserviceException

Description copied from interface: BaseDocument

Retrieve a list of language.

Specified by:: getDetectedLanguages in interface BaseDocument
Returns:: List The list detected languages
Throws:: AccessDeniedException - the access denied exception; RepositoryException - the repository exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

extendedDocumentCopy

public Document extendedDocumentCopy(String uuid,
                                     String dstId,
                                     String name,
                                     boolean categories,
                                     boolean keywords,
                                     boolean propertyGroups,
                                     boolean notes,
                                     boolean security)
                              throws ItemExistsException,
                                     PathNotFoundException,
                                     AccessDeniedException,
                                     RepositoryException,
                                     DatabaseException,
                                     UserQuotaExceededException,
                                     AutomationException,
                                     PromotedAsRecordLockException,
                                     UnknownException,
                                     WebserviceException

Description copied from interface: BaseDocument

Copy a document to another location in the repository.

Specified by:: extendedDocumentCopy in interface BaseDocument
Parameters:: uuid - Node uuid.; dstId - The destination folder path or its UUID.; name - The new document name.; categories - The categories; keywords - The keywords; propertyGroups - The propertyGroups; notes - The notes; security - The security
Returns:: An object document
Throws:: ItemExistsException - the item exists exception; PathNotFoundException - the path not found exception; AccessDeniedException - the access denied exception; RepositoryException - the repository exception; DatabaseException - the database exception; UserQuotaExceededException - the user quota exceeded exception; AutomationException - the automation exception; PromotedAsRecordLockException - the promoted as record lock exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

getExtractedText

public String getExtractedText(String uuid)
                        throws AccessDeniedException,
                               RepositoryException,
                               PathNotFoundException,
                               DatabaseException,
                               UnknownException,
                               WebserviceException

Description copied from interface: BaseDocument

Obtain the document extracted text.

Specified by:: getExtractedText in interface BaseDocument
Parameters:: uuid - Node uuid
Returns:: Returns the text of the document.
Throws:: AccessDeniedException - the access denied exception; RepositoryException - the repository exception; PathNotFoundException - the path not found exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

setExtractedText

public void setExtractedText(String uuid,
                             InputStream is)
                      throws AccessDeniedException,
                             PathNotFoundException,
                             DatabaseException,
                             UnknownException,
                             WebserviceException

Description copied from interface: BaseDocument

Sets extracted text.

Specified by:: setExtractedText in interface BaseDocument
Parameters:: uuid - the uuid; is - the is
Throws:: AccessDeniedException - the access denied exception; PathNotFoundException - the path not found exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

getThumbnail

public InputStream getThumbnail(String uuid,
                                ThumbnailType type)
                         throws PathNotFoundException,
                                AccessDeniedException,
                                ConversionException,
                                AutomationException,
                                RepositoryException,
                                DatabaseException,
                                UnknownException,
                                WebserviceException

Description copied from interface: BaseDocument

Returns thumbnail image data.

Specified by:: getThumbnail in interface BaseDocument
Parameters:: uuid - Node uuid; type - ThumbnailType
Returns:: Returns thumbnail image data.
Throws:: PathNotFoundException - the path not found exception; AccessDeniedException - the access denied exception; ConversionException - the conversion exception; AutomationException - the automation exception; RepositoryException - the repository exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

createDocumentFromTemplate

public Document createDocumentFromTemplate(String uuid,
                                           String dstPath,
                                           boolean categories,
                                           boolean keywords,
                                           boolean notes,
                                           boolean security,
                                           Map<String,String> properties)
                                    throws PathNotFoundException,
                                           AccessDeniedException,
                                           RepositoryException,
                                           DatabaseException,
                                           DocumentException,
                                           TemplateException,
                                           DocumentTemplateException,
                                           ConversionException,
                                           UnsupportedMimeTypeException,
                                           FileSizeExceededException,
                                           UserQuotaExceededException,
                                           VirusDetectedException,
                                           ItemExistsException,
                                           AutomationException,
                                           FilePlanException,
                                           PromotedAsRecordLockException,
                                           ParseException,
                                           NoSuchGroupException,
                                           NoSuchPropertyException,
                                           LockException,
                                           ValidationFormException,
                                           ClassNotFoundException,
                                           UnknownException,
                                           WebserviceException

Description copied from interface: BaseDocument

Create document from template document.

Specified by:: createDocumentFromTemplate in interface BaseDocument
Parameters:: uuid - the uuid; dstPath - the dst path; categories - the categories; keywords - the keywords; notes - the notes; security - the security; properties - the properties
Returns:: the document
Throws:: PathNotFoundException - the path not found exception; AccessDeniedException - the access denied exception; RepositoryException - the repository exception; DatabaseException - the database exception; DocumentException - the document exception; TemplateException - the template exception; DocumentTemplateException - the document template exception; ConversionException - the conversion exception; UnsupportedMimeTypeException - the unsupported mime type exception; FileSizeExceededException - the file size exceeded exception; UserQuotaExceededException - the user quota exceeded exception; VirusDetectedException - the virus detected exception; ItemExistsException - the item exists exception; AutomationException - the automation exception; FilePlanException - the file plan exception; PromotedAsRecordLockException - the promoted as record lock exception; ParseException - the parse exception; NoSuchGroupException - the no such group exception; NoSuchPropertyException - the no such property exception; LockException - the lock exception; ValidationFormException - the validation form exception; ClassNotFoundException - the class not found exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

updateDocumentFromTemplate

public void updateDocumentFromTemplate(String uuid,
                                       String dstId,
                                       Map<String,String> properties)
                                throws DocumentException,
                                       TemplateException,
                                       DocumentTemplateException,
                                       ConversionException,
                                       FileSizeExceededException,
                                       UserQuotaExceededException,
                                       VirusDetectedException,
                                       LockException,
                                       PathNotFoundException,
                                       ParseException,
                                       AccessDeniedException,
                                       RepositoryException,
                                       DatabaseException,
                                       AutomationException,
                                       PromotedAsRecordLockException,
                                       NoSuchGroupException,
                                       NoSuchPropertyException,
                                       ValidationFormException,
                                       ClassNotFoundException,
                                       UnknownException,
                                       WebserviceException

Description copied from interface: BaseDocument

Update from template

Specified by:: updateDocumentFromTemplate in interface BaseDocument
Parameters:: uuid - Node uuid; dstId - The destination folder path; properties - The property values.
Throws:: DocumentException - the document exception; TemplateException - the template exception; DocumentTemplateException - the document template exception; ConversionException - the conversion exception; FileSizeExceededException - the file size exceeded exception; UserQuotaExceededException - the user quota exceeded exception; VirusDetectedException - the virus detected exception; LockException - the lock exception; PathNotFoundException - the path not found exception; ParseException - the parse exception; AccessDeniedException - the access denied exception; RepositoryException - the repository exception; DatabaseException - the database exception; AutomationException - the automation exception; PromotedAsRecordLockException - the promoted as record lock exception; NoSuchGroupException - the no such group exception; NoSuchPropertyException - the no such property exception; ValidationFormException - the validation form exception; ClassNotFoundException - the class not found exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

getCheckedOut

public List<Document> getCheckedOut()
                             throws AccessDeniedException,
                                    PathNotFoundException,
                                    RepositoryException,
                                    DatabaseException,
                                    WebserviceException,
                                    UnknownException

Description copied from interface: BaseDocument

Get checked out documents

Specified by:: getCheckedOut in interface BaseDocument
Returns:: The list of checked out documents.
Throws:: AccessDeniedException - the access denied exception; PathNotFoundException - the path not found exception; RepositoryException - the repository exception; DatabaseException - the database exception; WebserviceException - the webservice exception; UnknownException - the unknown exception

setDocumentDescription

public void setDocumentDescription(String uuid,
                                   String description)
                            throws LockException,
                                   VersionException,
                                   PathNotFoundException,
                                   AccessDeniedException,
                                   RepositoryException,
                                   DatabaseException,
                                   PromotedAsRecordLockException,
                                   WebserviceException,
                                   UnknownException

Description copied from interface: BaseDocument

Set document description.

Specified by:: setDocumentDescription in interface BaseDocument
Parameters:: uuid - Node uuid; description - The description
Throws:: LockException - the lock exception; VersionException - the version exception; PathNotFoundException - the path not found exception; AccessDeniedException - the access denied exception; RepositoryException - the repository exception; DatabaseException - the database exception; PromotedAsRecordLockException - the promoted as record lock exception; WebserviceException - the webservice exception; UnknownException - the unknown exception

createWizardDocument

public WizardNode createWizardDocument(String uuid,
                                       String name,
                                       long nodeClass,
                                       InputStream is)
                                throws UnsupportedMimeTypeException,
                                       FileSizeExceededException,
                                       UserQuotaExceededException,
                                       VirusDetectedException,
                                       ItemExistsException,
                                       PathNotFoundException,
                                       AccessDeniedException,
                                       RepositoryException,
                                       DatabaseException,
                                       ExtensionException,
                                       AutomationException,
                                       PromotedAsRecordLockException,
                                       UnknownException,
                                       WebserviceException

Description copied from interface: BaseDocument

Create a new document with wizard.

Specified by:: createWizardDocument in interface BaseDocument
Parameters:: uuid - Node uuid; name - The document name.; nodeClass - The nodeClass; is - The document content in bytes.
Returns:: An object WizardName
Throws:: UnsupportedMimeTypeException - the unsupported mime type exception; FileSizeExceededException - the file size exceeded exception; UserQuotaExceededException - the user quota exceeded exception; VirusDetectedException - the virus detected exception; ItemExistsException - the item exists exception; PathNotFoundException - the path not found exception; AccessDeniedException - the access denied exception; RepositoryException - the repository exception; DatabaseException - the database exception; ExtensionException - the extension exception; AutomationException - the automation exception; PromotedAsRecordLockException - the promoted as record lock exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

getNumberOfPages
```
public int getNumberOfPages(String uuid)
                     throws AccessDeniedException,
                            RepositoryException,
                            DatabaseException,
                            WebserviceException,
                            UnknownException,
                            PrincipalAdapterException
```
Description copied from interface: BaseDocument

Get the number of pages of a document.

Specified by:

getNumberOfPages in interface BaseDocument

Parameters:

uuid - Node uuid

Returns:

Returns the number of pages of a document

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

PrincipalAdapterException - the principal adapter exception

getPageAsImage

public String getPageAsImage(String uuid,
                             int pageNumber,
                             int maxWidth,
                             int maxHeight)
                      throws AccessDeniedException,
                             RepositoryException,
                             DatabaseException,
                             WebserviceException,
                             UnknownException,
                             PrincipalAdapterException

Description copied from interface: BaseDocument

Get page as image.

Specified by:: getPageAsImage in interface BaseDocument
Parameters:: uuid - Node uuid; pageNumber - The page number; maxWidth - The maximum width; maxHeight - The maximum height
Returns:: Return specific page as an image encoded as a String in b64.
Throws:: AccessDeniedException - the access denied exception; RepositoryException - the repository exception; DatabaseException - the database exception; WebserviceException - the webservice exception; UnknownException - the unknown exception; PrincipalAdapterException - the principal adapter exception

getDocumentPdf

public InputStream getDocumentPdf(String uuid)
                           throws PathNotFoundException,
                                  AccessDeniedException,
                                  ConversionException,
                                  AutomationException,
                                  RepositoryException,
                                  DatabaseException,
                                  UnknownException,
                                  WebserviceException

Description copied from interface: BaseDocument

PDF of the document.

Specified by:: getDocumentPdf in interface BaseDocument
Parameters:: uuid - Node uuid
Returns:: Returns a PDF of the document.
Throws:: PathNotFoundException - the path not found exception; AccessDeniedException - the access denied exception; ConversionException - the conversion exception; AutomationException - the automation exception; RepositoryException - the repository exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

isAttachment
```
public boolean isAttachment(String uuid)
                     throws PathNotFoundException,
                            AccessDeniedException,
                            RepositoryException,
                            DatabaseException,
                            UnknownException,
                            WebserviceException
```
Description copied from interface: BaseDocument

Indicates if the node is a mail attachment or not.

Specified by:

isAttachment in interface BaseDocument

Parameters:

uuid - Node uuid

Returns:

Returns a boolean that indicates if the node is a mail attachment or not.

Throws:

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

Class DocumentImpl

Constructor Summary

Method Summary

Methods inherited from class com.openkm.sdk4j.impl.ClientImpl

Methods inherited from class java.lang.Object

Constructor Detail

DocumentImpl

Method Detail

setAuthorizationToken

createDocument

createDocument

createDocument

deleteDocument

getDocumentProperties

getContent

getContentByVersion

getDocumentChildren

renameDocument

setProperties

setLanguage

setDocumentTitle

checkout

cancelCheckout

forceCancelCheckout

isCheckedOut

checkin

checkin

isLocked

getLockInfo

purgeDocument

moveDocument

copyDocument

getVersionHistorySize

isValidDocument

getDocumentPath

getDetectedLanguages

extendedDocumentCopy

getExtractedText

setExtractedText

getThumbnail

createDocumentFromTemplate

updateDocumentFromTemplate

getCheckedOut

setDocumentDescription

createWizardDocument

getNumberOfPages

getPageAsImage

getDocumentPdf

isAttachment