DocumentImpl (OpenKM SDK for Java 3.7 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
Modifier and Type	Method and Description
`void`	`cancelCheckout(String uuid)`
`void`	`captureData(String uuid, long templateId)`
`Version`	`checkin(String uuid, InputStream is, String comment)`
`Version`	`checkin(String uuid, InputStream is, String comment, int increment)`
`void`	`checkout(String uuid)`
`Document`	`copyDocument(String uuid, String dstId, String newName)`
`Document`	`createDocument(String uuid, File file)`
`Document`	`createDocument(String uuid, String name, InputStream is)`
`Document`	`createDocumentFromTemplate(String uuid, String dstPath, String language, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean wiki, Map<String,String> properties)`
`WizardNode`	`createWizardDocument(String uuid, String name, long nodeClass, InputStream is)`
`void`	`deleteDocument(String uuid)`
`Document`	`extendedDocumentCopy(String uuid, String dstId, String name, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean wiki)`
`void`	`forceCancelCheckout(String uuid)`
`void`	`forceUnlockDocument(String uuid)`
`String`	`getAnnotations(String uuid, String versionName)`
`List<Document>`	`getCheckedOut()`
`InputStream`	`getContent(String uuid)`
`InputStream`	`getContentByVersion(String uuid, String versionName)`
`List<String>`	`getDetectedLanguages()`
`InputStream`	`getDifferences(String uuid, String versionName1, String versionName2)`
`List<Document>`	`getDocumentChildren(String uuid)`
`String`	`getDocumentPath(String uuid)`
`Document`	`getDocumentProperties(String uuid)`
`String`	`getExtractedText(String uuid)`
`List<String>`	`getLiveEditRestrictedMimeTypes()`
`LockInfo`	`getLockInfo(String uuid)`
`int`	`getNumberOfPages(String uuid)`
`String`	`getPageAsImage(String uuid, int pageNumber, int maxWidth, int maxHeight)`
`InputStream`	`getThumbnail(String uuid, ThumbnailType type)`
`long`	`getVersionHistorySize(String uuid)`
`boolean`	`isCheckedOut(String uuid)`
`boolean`	`isLocked(String uuid)`
`boolean`	`isOCRDataCaptureSupported(String uuid)`
`boolean`	`isValidDocument(String uuid)`
`void`	`liveEditCheckin(String uuid, String comment, int increment)`
`void`	`liveEditSetContent(String uuid, InputStream is)`
`LockInfo`	`lockDocument(String uuid)`
`void`	`mergePdf(String destinationUuid, String docName, List<String> uuids)`
`void`	`moveDocument(String uuid, String dstId)`
`void`	`purgeDocument(String uuid)`
`OCRRecognise`	`recognize(String uuid)`
`Document`	`renameDocument(String uuid, String newName)`
`void`	`setAuthorizationToken(String authorizationToken)` setAuthenticationToken
`void`	`setDocumentDescription(String uuid, String description)`
`void`	`setDocumentDispositionStage(String uuid, long stage)`
`void`	`setDocumentNodeClass(String uuid, long ncId)`
`void`	`setDocumentTitle(String uuid, String title)`
`void`	`setLanguage(String uuid, String lang)`
`void`	`setProperties(String uuid, String title, String description, String lang, List<String> keywords, List<String> categories)`
`void`	`unlockDocument(String uuid)`
`void`	`updateDocumentFromTemplate(String uuid, String dstId, Map<String,String> properties)`

Methods inherited from class com.openkm.sdk4j.impl.ClientImpl
getClient, getClient, 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 IOException,
                               UnsupportedMimeTypeException,
                               FileSizeExceededException,
                               UserQuotaExceededException,
                               VirusDetectedException,
                               ItemExistsException,
                               PathNotFoundException,
                               AccessDeniedException,
                               RepositoryException,
                               DatabaseException,
                               ExtensionException,
                               AutomationException,
                               PromotedAsRecordLockException,
                               UnknowException,
                               WebserviceException

Specified by:: createDocument in interface BaseDocument
Throws:: IOException; UnsupportedMimeTypeException; FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; ExtensionException; AutomationException; PromotedAsRecordLockException; UnknowException; WebserviceException

createDocument

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

Specified by:: createDocument in interface BaseDocument
Throws:: IOException; UnsupportedMimeTypeException; FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; ExtensionException; AutomationException; PromotedAsRecordLockException; UnknowException; WebserviceException

deleteDocument

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

Specified by:: deleteDocument in interface BaseDocument
Throws:: AutomationException; AccessDeniedException; RepositoryException; PathNotFoundException; LockException; DatabaseException; ExtensionException; PromotedAsRecordLockException; UnknowException; WebserviceException

getDocumentProperties

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

Specified by:: getDocumentProperties in interface BaseDocument
Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; DatabaseException; UnknowException; WebserviceException

getContent

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

Specified by:: getContent in interface BaseDocument
Throws:: RepositoryException; IOException; PathNotFoundException; AccessDeniedException; DatabaseException; UnknowException; WebserviceException

getContentByVersion

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

Specified by:: getContentByVersion in interface BaseDocument
Throws:: RepositoryException; IOException; PathNotFoundException; AccessDeniedException; DatabaseException; UnknowException; WebserviceException

getDocumentChildren

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

Specified by:: getDocumentChildren in interface BaseDocument
Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; DatabaseException; UnknowException; WebserviceException

renameDocument

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

Specified by:: renameDocument in interface BaseDocument
Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; ItemExistsException; LockException; DatabaseException; ExtensionException; PromotedAsRecordLockException; AutomationException; UnknowException; WebserviceException

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,
                          UnknowException,
                          WebserviceException

Specified by:: setProperties in interface BaseDocument
Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; VersionException; LockException; DatabaseException; PromotedAsRecordLockException; UnknowException; WebserviceException

setLanguage

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

Specified by:: setLanguage in interface BaseDocument
Throws:: VersionException; LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; PromotedAsRecordLockException; UnknowException; WebserviceException

setDocumentTitle

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

Specified by:: setDocumentTitle in interface BaseDocument
Throws:: VersionException; LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; PromotedAsRecordLockException; UnknowException; WebserviceException

setDocumentNodeClass

public void setDocumentNodeClass(String uuid,
                                 long ncId)
                          throws VersionException,
                                 LockException,
                                 PathNotFoundException,
                                 AccessDeniedException,
                                 RepositoryException,
                                 DatabaseException,
                                 PromotedAsRecordLockException,
                                 UnknowException,
                                 WebserviceException

Specified by:: setDocumentNodeClass in interface BaseDocument
Throws:: VersionException; LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; PromotedAsRecordLockException; UnknowException; WebserviceException

checkout

public void checkout(String uuid)
              throws AccessDeniedException,
                     RepositoryException,
                     PathNotFoundException,
                     LockException,
                     DatabaseException,
                     UnknowException,
                     WebserviceException

Specified by:: checkout in interface BaseDocument
Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; LockException; DatabaseException; UnknowException; WebserviceException

cancelCheckout

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

Specified by:: cancelCheckout in interface BaseDocument
Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; LockException; DatabaseException; UnknowException; WebserviceException

forceCancelCheckout

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

Specified by:: forceCancelCheckout in interface BaseDocument
Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; LockException; DatabaseException; PrincipalAdapterException; UnknowException; WebserviceException

isCheckedOut

public boolean isCheckedOut(String uuid)
                     throws AccessDeniedException,
                            PathNotFoundException,
                            RepositoryException,
                            DatabaseException,
                            UnknowException,
                            WebserviceException

Specified by:: isCheckedOut in interface BaseDocument
Throws:: AccessDeniedException; PathNotFoundException; RepositoryException; DatabaseException; UnknowException; WebserviceException

checkin

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

Specified by:: checkin in interface BaseDocument
Throws:: FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; LockException; VersionException; PathNotFoundException; AccessDeniedException; RepositoryException; IOException; DatabaseException; ExtensionException; AutomationException; PromotedAsRecordLockException; UnknowException; WebserviceException

checkin

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

Specified by:: checkin in interface BaseDocument
Throws:: FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; LockException; VersionException; PathNotFoundException; AccessDeniedException; RepositoryException; IOException; DatabaseException; ExtensionException; AutomationException; PromotedAsRecordLockException; UnknowException; WebserviceException

lockDocument

public LockInfo lockDocument(String uuid)
                      throws LockException,
                             PathNotFoundException,
                             AccessDeniedException,
                             RepositoryException,
                             DatabaseException,
                             UnknowException,
                             WebserviceException

Specified by:: lockDocument in interface BaseDocument
Throws:: LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknowException; WebserviceException

unlockDocument

public void unlockDocument(String uuid)
                    throws LockException,
                           PathNotFoundException,
                           AccessDeniedException,
                           RepositoryException,
                           DatabaseException,
                           UnknowException,
                           WebserviceException

Specified by:: unlockDocument in interface BaseDocument
Throws:: LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknowException; WebserviceException

forceUnlockDocument

public void forceUnlockDocument(String uuid)
                         throws LockException,
                                PathNotFoundException,
                                AccessDeniedException,
                                RepositoryException,
                                DatabaseException,
                                PrincipalAdapterException,
                                UnknowException,
                                WebserviceException

Specified by:: forceUnlockDocument in interface BaseDocument
Throws:: LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; PrincipalAdapterException; UnknowException; WebserviceException

isLocked

public boolean isLocked(String uuid)
                 throws AccessDeniedException,
                        RepositoryException,
                        PathNotFoundException,
                        DatabaseException,
                        UnknowException,
                        WebserviceException

Specified by:: isLocked in interface BaseDocument
Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; DatabaseException; UnknowException; WebserviceException

getLockInfo

public LockInfo getLockInfo(String uuid)
                     throws AccessDeniedException,
                            RepositoryException,
                            PathNotFoundException,
                            LockException,
                            DatabaseException,
                            UnknowException,
                            WebserviceException

Specified by:: getLockInfo in interface BaseDocument
Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; LockException; DatabaseException; UnknowException; WebserviceException

purgeDocument

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

Specified by:: purgeDocument in interface BaseDocument
Throws:: LockException; AccessDeniedException; RepositoryException; PathNotFoundException; DatabaseException; ExtensionException; PromotedAsRecordLockException; UnknowException; WebserviceException

moveDocument

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

Specified by:: moveDocument in interface BaseDocument
Throws:: LockException; PathNotFoundException; ItemExistsException; AccessDeniedException; RepositoryException; DatabaseException; ExtensionException; PromotedAsRecordLockException; AutomationException; FilePlanCatalogManagerException; VersionException; UnknowException; WebserviceException

copyDocument

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

Specified by:: copyDocument in interface BaseDocument
Throws:: ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; IOException; DatabaseException; UserQuotaExceededException; ExtensionException; AutomationException; PromotedAsRecordLockException; UnknowException; WebserviceException

getVersionHistorySize

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

Specified by:: getVersionHistorySize in interface BaseDocument
Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; DatabaseException; UnknowException; WebserviceException

isValidDocument

public boolean isValidDocument(String uuid)
                        throws PathNotFoundException,
                               AccessDeniedException,
                               RepositoryException,
                               DatabaseException,
                               UnknowException,
                               WebserviceException

Specified by:: isValidDocument in interface BaseDocument
Throws:: PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknowException; WebserviceException

getDocumentPath

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

Specified by:: getDocumentPath in interface BaseDocument
Throws:: AccessDeniedException; RepositoryException; DatabaseException; UnknowException; WebserviceException

getDetectedLanguages

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

Specified by:: getDetectedLanguages in interface BaseDocument
Throws:: AccessDeniedException; RepositoryException; DatabaseException; UnknowException; WebserviceException

extendedDocumentCopy

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

Specified by:: extendedDocumentCopy in interface BaseDocument
Throws:: ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; IOException; DatabaseException; UserQuotaExceededException; AutomationException; PromotedAsRecordLockException; UnknowException; WebserviceException

getExtractedText

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

Specified by:: getExtractedText in interface BaseDocument
Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; IOException; DatabaseException; UnknowException; WebserviceException

getThumbnail

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

Specified by:: getThumbnail in interface BaseDocument
Throws:: PathNotFoundException; AccessDeniedException; ConversionException; AutomationException; RepositoryException; DatabaseException; IOException; UnknowException; WebserviceException

createDocumentFromTemplate

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

Specified by:: createDocumentFromTemplate in interface BaseDocument
Throws:: PathNotFoundException; AccessDeniedException; RepositoryException; IOException; DatabaseException; DocumentException; TemplateException; DocumentTemplateException; ConversionException; UnsupportedMimeTypeException; FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; ItemExistsException; AutomationException; FilePlanException; PromotedAsRecordLockException; ParseException; NoSuchGroupException; NoSuchPropertyException; LockException; ValidationFormException; ClassNotFoundException; UnknowException; WebserviceException

updateDocumentFromTemplate

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

Specified by:: updateDocumentFromTemplate in interface BaseDocument
Throws:: DocumentException; TemplateException; DocumentTemplateException; ConversionException; FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; LockException; VersionException; PathNotFoundException; ParseException; AccessDeniedException; RepositoryException; IOException; DatabaseException; AutomationException; PromotedAsRecordLockException; NoSuchGroupException; NoSuchPropertyException; ValidationFormException; ClassNotFoundException; UnknowException; WebserviceException

getAnnotations

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

Specified by:: getAnnotations in interface BaseDocument
Throws:: AccessDeniedException; PathNotFoundException; DatabaseException; UnknowException; WebserviceException

getDifferences

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

Specified by:: getDifferences in interface BaseDocument
Throws:: IOException; RepositoryException; AccessDeniedException; PathNotFoundException; DatabaseException; AutomationException; ConversionException; TemplateException; InterruptedException; WebserviceException; UnknowException

getCheckedOut

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

Specified by:: getCheckedOut in interface BaseDocument
Throws:: AccessDeniedException; PathNotFoundException; RepositoryException; DatabaseException; WebserviceException; UnknowException

setDocumentDispositionStage

public void setDocumentDispositionStage(String uuid,
                                        long stage)
                                 throws PathNotFoundException,
                                        AccessDeniedException,
                                        DatabaseException,
                                        WebserviceException,
                                        UnknowException

Specified by:: setDocumentDispositionStage in interface BaseDocument
Throws:: PathNotFoundException; AccessDeniedException; DatabaseException; WebserviceException; UnknowException

setDocumentDescription

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

Specified by:: setDocumentDescription in interface BaseDocument
Throws:: LockException; VersionException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; PromotedAsRecordLockException; WebserviceException; UnknowException

createWizardDocument

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

Specified by:: createWizardDocument in interface BaseDocument
Throws:: IOException; UnsupportedMimeTypeException; FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; ExtensionException; AutomationException; PromotedAsRecordLockException; UnknowException; WebserviceException

isOCRDataCaptureSupported

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

Specified by:: isOCRDataCaptureSupported in interface BaseDocument
Throws:: IOException; UnsupportedMimeTypeException; FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; ExtensionException; AutomationException; UnknowException; WebserviceException

recognize

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

Specified by:: recognize in interface BaseDocument
Throws:: IOException; UnsupportedMimeTypeException; FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; ExtensionException; AutomationException; UnknowException; WebserviceException

captureData

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

Specified by:: captureData in interface BaseDocument
Throws:: IOException; UnsupportedMimeTypeException; FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; ExtensionException; AutomationException; UnknowException; WebserviceException

getNumberOfPages

public int getNumberOfPages(String uuid)
                     throws AccessDeniedException,
                            RepositoryException,
                            DatabaseException,
                            WebserviceException,
                            UnknowException,
                            PrincipalAdapterException

Specified by:: getNumberOfPages in interface BaseDocument
Throws:: AccessDeniedException; RepositoryException; DatabaseException; WebserviceException; UnknowException; PrincipalAdapterException

getPageAsImage

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

Specified by:: getPageAsImage in interface BaseDocument
Throws:: AccessDeniedException; RepositoryException; DatabaseException; WebserviceException; UnknowException; PrincipalAdapterException

mergePdf

public void mergePdf(String destinationUuid,
                     String docName,
                     List<String> uuids)
              throws AccessDeniedException,
                     RepositoryException,
                     DatabaseException,
                     WebserviceException,
                     UnknowException,
                     PrincipalAdapterException

Specified by:: mergePdf in interface BaseDocument
Throws:: AccessDeniedException; RepositoryException; DatabaseException; WebserviceException; UnknowException; PrincipalAdapterException

getLiveEditRestrictedMimeTypes

public List<String> getLiveEditRestrictedMimeTypes()
                                            throws WebserviceException,
                                                   UnknowException

Specified by:: getLiveEditRestrictedMimeTypes in interface BaseDocument
Throws:: WebserviceException; UnknowException

liveEditCheckin

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

Specified by:: liveEditCheckin in interface BaseDocument
Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; LockException; IOException; DatabaseException; AutomationException; PromotedAsRecordLockException; UnknowException; WebserviceException

liveEditSetContent

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

Specified by:: liveEditSetContent in interface BaseDocument
Throws:: AutomationException; AccessDeniedException; RepositoryException; PathNotFoundException; LockException; DatabaseException; ExtensionException; PromotedAsRecordLockException; UnknowException; WebserviceException; IOException

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

deleteDocument

getDocumentProperties

getContent

getContentByVersion

getDocumentChildren

renameDocument

setProperties

setLanguage

setDocumentTitle

setDocumentNodeClass

checkout

cancelCheckout

forceCancelCheckout

isCheckedOut

checkin

checkin

lockDocument

unlockDocument

forceUnlockDocument

isLocked

getLockInfo

purgeDocument

moveDocument

copyDocument

getVersionHistorySize

isValidDocument

getDocumentPath

getDetectedLanguages

extendedDocumentCopy

getExtractedText

getThumbnail

createDocumentFromTemplate

updateDocumentFromTemplate

getAnnotations

getDifferences

getCheckedOut

setDocumentDispositionStage

setDocumentDescription

createWizardDocument

isOCRDataCaptureSupported

recognize

captureData

getNumberOfPages

getPageAsImage

mergePdf

getLiveEditRestrictedMimeTypes

liveEditCheckin

liveEditSetContent