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:

sochoa

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

DocumentImpl(String host)
DocumentImpl

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`cancelCheckout(String uuid)`	Cancel a previous checked out state in a document.
`void`	`captureData(String uuid, long templateId)`	Proceed to the OCR data capture using OCR template identified by templateId.
`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`	`copy(String uuid, String dstId, String newName)`	Copy a document to another location in the repository.
`Document`	`create(String uuid, File file)`	Creates a new document
`Document`	`create(String uuid, String name, InputStream is)`	Creates a new document
`Document`	`create(String uuid, String name, InputStream is, long nodeClass)`	Creates a new document
`Document`	`createFromTemplate(String uuid, String dstPath, boolean categories, boolean keywords, boolean notes, boolean security, Map<String,String> properties)`	Create from template document.
`Document`	`createFromTemplate(String uuid, String dstPath, boolean categories, boolean keywords, boolean notes, Map<String,String> properties)`	Deprecated. As of sdk4j 4.3, replaced by `createFromTemplate(String, String, boolean, boolean, boolean, boolean, Map)`
`WizardNode`	`createWizard(String uuid, String name, long nodeClass, InputStream is)`	Create a new document with wizard.
`void`	`delete(String uuid)`	Deletes a document from the repository.
`Document`	`extendedCopy(String uuid, String dstId, String newName, 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.
`String`	`getAnnotations(String uuid, String versionName)`	Get annotations for document
`List<Document>`	`getCheckedOut()`	Get checked out documents
`List<Document>`	`getChildren(String uuid)`	Gets children.
`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.
`InputStream`	`getDifferences(String uuid, String versionName1, String versionName2)`	Get differences between two document versions.
`String`	`getExtractedText(String uuid)`	Obtain the document extracted text.
`List<String>`	`getLiveEditRestrictedMimeTypes()`	Get mimetypes what can not be used with liveedit feature.
`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.
`String`	`getPath(String uuid)`	Get the document path from a UUID
`InputStream`	`getPdf(String uuid)`	PDF of the document.
`Document`	`getProperties(String uuid)`	Obtain document properties from the repository.
`InputStream`	`getThumbnail(String uuid, ThumbnailType type)`	Returns thumbnail image data.
`long`	`getVersionHistorySize(String uuid)`	Get the versions size of a Document.
`List<XRef>`	`getXrefs(String uuid)`	Returns a list of the document references of a Autocad 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`	`isConvertibleToPDF(String uuid)`	Is convertible to pdf
`boolean`	`isOCRDataCaptureSupported(String uuid)`	Check if the node supports an OCR data capture.
`boolean`	`isValid(String uuid)`	Test if a document path exists and is readable.
`void`	`liveEditCancelCheckout(String uuid)`	Live edit cancel checkout.
`void`	`liveEditCheckin(String uuid, String comment, int increment)`	It does a live edit checkin.
`void`	`liveEditForceCancelCheckout(String uuid)`	Live edit force cancel checkout.
`void`	`liveEditSetContent(String uuid, InputStream is)`	Update the content of the document edited with live edit feature.
`String`	`mergePdf(String dstId, String docName, List<String> uuids)`	Merge PDF documents.
`void`	`move(String uuid, String dstId)`	Move a document to another location in the repository.
`void`	`purge(String uuid)`	Deletes definitively a document from the repository.
`OCRRecognise`	`recognize(String uuid)`	Recognize
`void`	`refresh(String uuid)`	Refresh references of an Autocad document
`Document`	`rename(String uuid, String newName)`	Rename a document in the repository.
`Document`	`saveAsPdf(String uuid, String newName, boolean propertyGroups, boolean security)`	Save the document as PDF in the OpenKM repository.
`protected void`	`setAuthorizationToken(String authorizationToken)`	setAuthenticationToken
`void`	`setDescription(String uuid, String description)`	Set document description.
`void`	`setDispositionStage(String uuid, long stage)`	Set disposition stage
`void`	`setExtractedText(String uuid, InputStream is)`	Sets extracted text.
`void`	`setIndexable(String uuid, boolean enabled)`	Sets indexable.
`void`	`setLanguage(String uuid, String lang)`	Set document language.
`void`	`setNodeClass(String uuid, long nodeClass)`	Set document node class
`void`	`setProperties(String uuid, String title, String description, String lang, List<String> keywords, List<String> categories)`	Set document properties in the repository.
`void`	`setTitle(String uuid, String title)`	Set document title.
`void`	`stamp(String uuid, int type, long stampId)`	Stamp.
`void`	`updateFromTemplate(String uuid, String dstId, Map<String,String> properties)`	Update from template
`void`	`webPageImport(String uuid, String url)`	Web page import.

Methods inherited from class com.openkm.sdk4j.impl.ClientImpl
getClient, getWebTarget, setAuthorizationHeader, setJsessionIdHeader

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

protected void setAuthorizationToken(String authorizationToken)

setAuthenticationToken

create

public Document create(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:: create 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

create

public Document create(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:: create 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

create

public Document create(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:: create 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

delete
```
public void delete(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:

delete 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

getProperties

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

Description copied from interface: BaseDocument

Obtain document properties from the repository.

Specified by:: getProperties 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

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

getChildren

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

Description copied from interface: BaseDocument

Gets children.

Specified by:: getChildren in interface BaseDocument
Parameters:: uuid - the uuid
Returns:: the children
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

rename

public Document rename(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:: rename 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

setTitle

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

Description copied from interface: BaseDocument

Set document title.

Specified by:: setTitle 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

setNodeClass

public void setNodeClass(String uuid,
                         long nodeClass)
                  throws VersionException,
                         LockException,
                         PathNotFoundException,
                         AccessDeniedException,
                         RepositoryException,
                         DatabaseException,
                         PromotedAsRecordLockException,
                         UnknownException,
                         WebserviceException

Description copied from interface: BaseDocument

Set document node class

Specified by:: setNodeClass in interface BaseDocument
Parameters:: uuid - Node uuid; nodeClass - The nodeClass id
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

setDispositionStage

public void setDispositionStage(String uuid,
                                long stage)
                         throws PathNotFoundException,
                                AccessDeniedException,
                                DatabaseException,
                                WebserviceException,
                                UnknownException

Description copied from interface: BaseDocument

Set disposition stage

Specified by:: setDispositionStage in interface BaseDocument
Parameters:: uuid - Node uuid; stage - the stage
Throws:: PathNotFoundException - the path not found exception; AccessDeniedException - the access denied exception; DatabaseException - the database exception; WebserviceException - the webservice exception; UnknownException - the unknown 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

purge
```
public void purge(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:

purge 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

move
```
public void move(String uuid,
                 String dstId)
          throws LockException,
                 PathNotFoundException,
                 ItemExistsException,
                 AccessDeniedException,
                 RepositoryException,
                 DatabaseException,
                 ExtensionException,
                 AutomationException,
                 PromotedAsRecordLockException,
                 FilePlanCatalogManagerException,
                 VersionException,
                 UnknownException,
                 WebserviceException
```
Description copied from interface: BaseDocument

Move a document to another location in the repository.

Specified by:

move 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

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

FilePlanCatalogManagerException - the file plan catalog manager exception

VersionException - the version exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

copy

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

Description copied from interface: BaseDocument

Copy a document to another location in the repository.

Specified by:: copy 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; UserQuotaExceededException - the user quota exceeded 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

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

Test if a document path exists and is readable.

Specified by:

isValid in interface BaseDocument

Parameters:

uuid - Node uuid

Returns:

True if is a valid document path, otherwise false.

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

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

Get the document path from a UUID

Specified by:

getPath 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

extendedCopy

public Document extendedCopy(String uuid,
                             String dstId,
                             String newName,
                             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:: extendedCopy in interface BaseDocument
Parameters:: uuid - Node uuid.; dstId - The destination folder path or its UUID.; newName - 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

createFromTemplate

public Document createFromTemplate(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 from template document.

Specified by:: createFromTemplate 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

createFromTemplate

@Deprecated
public Document createFromTemplate(String uuid,
                                   String dstPath,
                                   boolean categories,
                                   boolean keywords,
                                   boolean notes,
                                   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

Deprecated.

As of sdk4j 4.3, replaced by createFromTemplate(String, String, boolean, boolean, boolean, boolean, Map)

Create from template

Specified by:: createFromTemplate in interface BaseDocument
Parameters:: uuid - Node uuid; dstPath - The destination folder path; categories - The categories; keywords - The keywords; notes - The notes; properties - The property values.
Returns:: An object 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
See Also:: createFromTemplate(String, String, boolean, boolean, boolean, boolean, Map)

updateFromTemplate

public void updateFromTemplate(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:: updateFromTemplate 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

getAnnotations

public String getAnnotations(String uuid,
                             String versionName)
                      throws AccessDeniedException,
                             PathNotFoundException,
                             DatabaseException,
                             UnknownException,
                             WebserviceException

Description copied from interface: BaseDocument

Get annotations for document

Specified by:: getAnnotations in interface BaseDocument
Parameters:: uuid - Node uuid; versionName - The name of the version
Returns:: Returns annotations
Throws:: AccessDeniedException - the access denied exception; PathNotFoundException - the path not found exception; DatabaseException - the database exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

getDifferences

public InputStream getDifferences(String uuid,
                                  String versionName1,
                                  String versionName2)
                           throws RepositoryException,
                                  AccessDeniedException,
                                  PathNotFoundException,
                                  DatabaseException,
                                  AutomationException,
                                  ConversionException,
                                  TemplateException,
                                  InterruptedException,
                                  WebserviceException,
                                  UnknownException

Description copied from interface: BaseDocument

Get differences between two document versions.

Specified by:: getDifferences in interface BaseDocument
Parameters:: uuid - Node uuid; versionName1 - The name of the version; versionName2 - The name of the version
Returns:: Return a PDF document with the differences between two document versions.
Throws:: RepositoryException - the repository exception; AccessDeniedException - the access denied exception; PathNotFoundException - the path not found exception; DatabaseException - the database exception; AutomationException - the automation exception; ConversionException - the conversion exception; TemplateException - the template exception; InterruptedException - the interrupted exception; WebserviceException - the webservice exception; UnknownException - the unknown 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

stamp

public void stamp(String uuid,
                  int type,
                  long stampId)
           throws RepositoryException,
                  AccessDeniedException,
                  PathNotFoundException,
                  DatabaseException,
                  AutomationException,
                  UnsupportedMimeTypeException,
                  PromotedAsRecordLockException,
                  LockException,
                  DocumentException,
                  NumberFormatException,
                  PrincipalAdapterException,
                  WebserviceException,
                  UnknownException

Description copied from interface: BaseDocument

Stamp.

Specified by:: stamp in interface BaseDocument
Parameters:: uuid - the uuid; type - the type; stampId - the stamp id
Throws:: RepositoryException - the repository exception; AccessDeniedException - the access denied exception; PathNotFoundException - the path not found exception; DatabaseException - the database exception; AutomationException - the automation exception; UnsupportedMimeTypeException - the unsupported mime type exception; PromotedAsRecordLockException - the promoted as record lock exception; LockException - the lock exception; DocumentException - the document exception; NumberFormatException - the number format exception; PrincipalAdapterException - the principal adapter exception; WebserviceException - the webservice exception; UnknownException - the unknown exception

setDescription

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

Description copied from interface: BaseDocument

Set document description.

Specified by:: setDescription 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

createWizard

public WizardNode createWizard(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:: createWizard 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

isOCRDataCaptureSupported

public boolean isOCRDataCaptureSupported(String uuid)
                                  throws UnsupportedMimeTypeException,
                                         FileSizeExceededException,
                                         UserQuotaExceededException,
                                         VirusDetectedException,
                                         ItemExistsException,
                                         PathNotFoundException,
                                         AccessDeniedException,
                                         RepositoryException,
                                         DatabaseException,
                                         ExtensionException,
                                         AutomationException,
                                         UnknownException,
                                         WebserviceException

Description copied from interface: BaseDocument

Check if the node supports an OCR data capture.

Specified by:: isOCRDataCaptureSupported in interface BaseDocument
Parameters:: uuid - Node uuid
Returns:: true if have OCR data capture supported, or false if not.
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; UnknownException - the unknown exception; WebserviceException - the webservice exception

recognize

public OCRRecognise recognize(String uuid)
                       throws UnsupportedMimeTypeException,
                              FileSizeExceededException,
                              UserQuotaExceededException,
                              VirusDetectedException,
                              ItemExistsException,
                              PathNotFoundException,
                              AccessDeniedException,
                              RepositoryException,
                              DatabaseException,
                              ExtensionException,
                              AutomationException,
                              UnknownException,
                              WebserviceException

Description copied from interface: BaseDocument

Recognize

Specified by:: recognize in interface BaseDocument
Parameters:: uuid - Node uuid
Returns:: Return an OCRRecognise object.
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; UnknownException - the unknown exception; WebserviceException - the webservice exception

captureData

public void captureData(String uuid,
                        long templateId)
                 throws UnsupportedMimeTypeException,
                        FileSizeExceededException,
                        UserQuotaExceededException,
                        VirusDetectedException,
                        ItemExistsException,
                        PathNotFoundException,
                        AccessDeniedException,
                        RepositoryException,
                        DatabaseException,
                        ExtensionException,
                        AutomationException,
                        UnknownException,
                        WebserviceException

Description copied from interface: BaseDocument

Proceed to the OCR data capture using OCR template identified by templateId.

Specified by:: captureData in interface BaseDocument
Parameters:: uuid - Node uuid; templateId - The template id
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; 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

mergePdf

public String mergePdf(String dstId,
                       String docName,
                       List<String> uuids)
                throws AccessDeniedException,
                       RepositoryException,
                       DatabaseException,
                       WebserviceException,
                       UnknownException,
                       PrincipalAdapterException

Description copied from interface: BaseDocument

Merge PDF documents.

Specified by:: mergePdf in interface BaseDocument
Parameters:: dstId - the destination uuid; docName - the doc name; uuids - the uuids
Returns:: the uuid of the PDF
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

getPdf

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

Description copied from interface: BaseDocument

PDF of the document.

Specified by:: getPdf 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

saveAsPdf

public Document saveAsPdf(String uuid,
                          String newName,
                          boolean propertyGroups,
                          boolean security)
                   throws RepositoryException,
                          AccessDeniedException,
                          PathNotFoundException,
                          DatabaseException,
                          ConversionException,
                          UnsupportedMimeTypeException,
                          VirusDetectedException,
                          ItemExistsException,
                          AutomationException,
                          PromotedAsRecordLockException,
                          PrincipalAdapterException,
                          UnknownException,
                          WebserviceException

Description copied from interface: BaseDocument

Save the document as PDF in the OpenKM repository.

Specified by:: saveAsPdf in interface BaseDocument
Parameters:: uuid - Node uuid; newName - The new name to the document; propertyGroups - the property groups; security - the security
Returns:: An object document
Throws:: RepositoryException - the repository exception; AccessDeniedException - the access denied exception; PathNotFoundException - the path not found exception; DatabaseException - the database exception; ConversionException - the conversion exception; UnsupportedMimeTypeException - the unsupported mime type exception; VirusDetectedException - the virus detected exception; ItemExistsException - the item exists exception; AutomationException - the automation exception; PromotedAsRecordLockException - the promoted as record lock exception; PrincipalAdapterException - the principal adapter exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

getLiveEditRestrictedMimeTypes
```
public List<String> getLiveEditRestrictedMimeTypes()
                                            throws WebserviceException,
                                                   UnknownException
```
Description copied from interface: BaseDocument

Get mimetypes what can not be used with liveedit feature.

Specified by:

getLiveEditRestrictedMimeTypes in interface BaseDocument

Returns:

Return a list of mimetypes what can not be used with liveedit feature.

Throws:

WebserviceException - the webservice exception

UnknownException - the unknown exception

liveEditCheckin

public void liveEditCheckin(String uuid,
                            String comment,
                            int increment)
                     throws AccessDeniedException,
                            RepositoryException,
                            PathNotFoundException,
                            LockException,
                            DatabaseException,
                            AutomationException,
                            PromotedAsRecordLockException,
                            UnknownException,
                            WebserviceException

Description copied from interface: BaseDocument

It does a live edit checkin.

Specified by:: liveEditCheckin in interface BaseDocument
Parameters:: uuid - Node uuid; comment - A comment for this checkin.; increment - Which increment should be increased.
Throws:: AccessDeniedException - the access denied exception; RepositoryException - the repository exception; PathNotFoundException - the path not found exception; LockException - the lock exception; DatabaseException - the database exception; AutomationException - the automation exception; PromotedAsRecordLockException - the promoted as record lock exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

liveEditCancelCheckout

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

Description copied from interface: BaseDocument

Live edit cancel checkout.

Specified by:: liveEditCancelCheckout in interface BaseDocument
Parameters:: uuid - the 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

liveEditForceCancelCheckout

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

Description copied from interface: BaseDocument

Live edit force cancel checkout.

Specified by:: liveEditForceCancelCheckout in interface BaseDocument
Parameters:: uuid - the 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

liveEditSetContent

public void liveEditSetContent(String uuid,
                               InputStream is)
                        throws AutomationException,
                               AccessDeniedException,
                               RepositoryException,
                               PathNotFoundException,
                               LockException,
                               DatabaseException,
                               PromotedAsRecordLockException,
                               UnknownException,
                               WebserviceException

Description copied from interface: BaseDocument

Update the content of the document edited with live edit feature.

Specified by:: liveEditSetContent in interface BaseDocument
Parameters:: uuid - Node uuid; is - The document content in bytes.
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; PromotedAsRecordLockException - the promoted as record lock 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

isConvertibleToPDF

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

Description copied from interface: BaseDocument

Is convertible to pdf

Specified by:: isConvertibleToPDF in interface BaseDocument
Parameters:: uuid - Node uuid
Returns:: Returns a boolean that indicates if the node is convertible to PDF 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

webPageImport

public void webPageImport(String uuid,
                          String url)
                   throws ConversionException,
                          UnknownException,
                          WebserviceException

Description copied from interface: BaseDocument

Web page import.

Specified by:: webPageImport in interface BaseDocument
Parameters:: uuid - the uuid; url - the url
Throws:: ConversionException - the conversion exception; UnknownException - the unknown exception; WebserviceException - the webservice exception

setIndexable

public void setIndexable(String uuid,
                         boolean enabled)
                  throws AccessDeniedException,
                         RepositoryException,
                         PathNotFoundException,
                         LockException,
                         DatabaseException,
                         PromotedAsRecordLockException,
                         UnknownException,
                         WebserviceException

Description copied from interface: BaseDocument

Sets indexable.

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

getXrefs
```
public List<XRef> getXrefs(String uuid)
                    throws RepositoryException,
                           AccessDeniedException,
                           PathNotFoundException,
                           DatabaseException,
                           UnknownException,
                           WebserviceException
```
Description copied from interface: BaseDocument

Returns a list of the document references of a Autocad document

Specified by:

getXrefs in interface BaseDocument

Parameters:

uuid - Node uuid

Returns:

List xrefs

Throws:

RepositoryException - the repository exception

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

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

Refresh references of an Autocad document

Specified by:

refresh in interface BaseDocument

Parameters:

uuid - Node uuid

Throws:

DatabaseException - the database exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

ParseException - the parse 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

create

create

create

delete

getProperties

getContent

getContentByVersion

getExtractedText

setExtractedText

getThumbnail

getChildren

rename

setProperties

setLanguage

setTitle

setNodeClass

setDispositionStage

checkout

cancelCheckout

forceCancelCheckout

isCheckedOut

checkin

checkin

purge

move

copy

getVersionHistorySize

isValid

getPath

getDetectedLanguages

extendedCopy

createFromTemplate

createFromTemplate

updateFromTemplate

getAnnotations

getDifferences

getCheckedOut

stamp

setDescription

createWizard

isOCRDataCaptureSupported

recognize

captureData

getNumberOfPages

getPageAsImage

mergePdf

getPdf

saveAsPdf

getLiveEditRestrictedMimeTypes

liveEditCheckin

liveEditCancelCheckout

liveEditForceCancelCheckout

liveEditSetContent

isAttachment

isConvertibleToPDF

webPageImport

setIndexable

getXrefs

refresh