BaseDocument (OpenKM SDK for Java 3.12 API)

All Known Implementing Classes:

DocumentImpl, OKMWebservices
```
public interface BaseDocument
```
BaseDocument

Author:

jllort

Method Summary

All Methods Instance Methods Abstract 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`	`createDocument(String uuid, String name, InputStream is, long nodeClass)`
`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 nodeId, String dstId, String name, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean wiki, boolean security)`
`void`	`forceCancelCheckout(String uuid)`
`LockInfo`	`forceLockDocument(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 fldId)`
`String`	`getDocumentPath(String uuid)`
`InputStream`	`getDocumentPdf(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`	`isAttachment(String uuid)`
`boolean`	`isCheckedOut(String uuid)`
`boolean`	`isConvertibleToPDF(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)`
`Document`	`saveDocumentAsPdf(String uuid, String newName)`
`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)`

Method Detail

createDocument

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

Throws:: UnsupportedMimeTypeException; FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; ExtensionException; AutomationException; PromotedAsRecordLockException; UnknownException; WebserviceException

createDocument

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

Throws:: UnsupportedMimeTypeException; FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; ExtensionException; AutomationException; PromotedAsRecordLockException; UnknownException; WebserviceException

createDocument

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

Throws:: UnsupportedMimeTypeException; FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; ExtensionException; AutomationException; PromotedAsRecordLockException; UnknownException; WebserviceException

deleteDocument

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

Throws:: AutomationException; AccessDeniedException; RepositoryException; PathNotFoundException; LockException; DatabaseException; ExtensionException; PromotedAsRecordLockException; UnknownException; WebserviceException

getDocumentProperties

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

Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; DatabaseException; UnknownException; WebserviceException

getContent

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

Throws:: RepositoryException; PathNotFoundException; AccessDeniedException; DatabaseException; UnknownException; WebserviceException

getContentByVersion

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

Throws:: RepositoryException; PathNotFoundException; AccessDeniedException; DatabaseException; UnknownException; WebserviceException

getDocumentChildren

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

Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; DatabaseException; UnknownException; WebserviceException

renameDocument

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

Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; ItemExistsException; LockException; DatabaseException; ExtensionException; PromotedAsRecordLockException; AutomationException; UnknownException; WebserviceException

setProperties

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

Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; VersionException; LockException; DatabaseException; PromotedAsRecordLockException; UnknownException; WebserviceException

setLanguage

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

Throws:: VersionException; LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; PromotedAsRecordLockException; UnknownException; WebserviceException

setDocumentTitle

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

Throws:: VersionException; LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; PromotedAsRecordLockException; UnknownException; WebserviceException

setDocumentNodeClass

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

Throws:: VersionException; LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; PromotedAsRecordLockException; UnknownException; WebserviceException

checkout

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

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

cancelCheckout

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

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

forceCancelCheckout

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

Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; LockException; DatabaseException; PrincipalAdapterException; UnknownException; WebserviceException

isCheckedOut

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

Throws:: AccessDeniedException; PathNotFoundException; RepositoryException; DatabaseException; UnknownException; WebserviceException

checkin

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

Throws:: FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; LockException; VersionException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; ExtensionException; AutomationException; PromotedAsRecordLockException; UnknownException; WebserviceException

checkin

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

Throws:: FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; LockException; VersionException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; ExtensionException; AutomationException; PromotedAsRecordLockException; UnknownException; WebserviceException

lockDocument

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

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

forceLockDocument

LockInfo forceLockDocument(String uuid)
                    throws AccessDeniedException,
                           LockException,
                           PathNotFoundException,
                           AccessDeniedException,
                           RepositoryException,
                           DatabaseException,
                           UnknownException,
                           WebserviceException

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

unlockDocument

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

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

forceUnlockDocument

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

Throws:: LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; PrincipalAdapterException; UnknownException; WebserviceException

isLocked

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

Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; DatabaseException; UnknownException; WebserviceException

getLockInfo

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

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

purgeDocument

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

Throws:: LockException; AccessDeniedException; RepositoryException; PathNotFoundException; DatabaseException; ExtensionException; PromotedAsRecordLockException; UnknownException; WebserviceException

moveDocument

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

Throws:: LockException; PathNotFoundException; ItemExistsException; AccessDeniedException; RepositoryException; DatabaseException; ExtensionException; AutomationException; PromotedAsRecordLockException; FilePlanCatalogManagerException; VersionException; UnknownException; WebserviceException

copyDocument

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

Throws:: ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UserQuotaExceededException; ExtensionException; AutomationException; PromotedAsRecordLockException; UnknownException; WebserviceException

getVersionHistorySize

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

Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; DatabaseException; UnknownException; WebserviceException

isValidDocument

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

Throws:: AccessDeniedException; PathNotFoundException; RepositoryException; DatabaseException; UnknownException; WebserviceException

getDocumentPath

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

Throws:: AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

getDetectedLanguages

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

Throws:: AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

extendedDocumentCopy

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

Throws:: ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UserQuotaExceededException; AutomationException; PromotedAsRecordLockException; UnknownException; WebserviceException

getExtractedText

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

Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; DatabaseException; UnknownException; WebserviceException

getThumbnail

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

Throws:: PathNotFoundException; AccessDeniedException; ConversionException; AutomationException; RepositoryException; DatabaseException; UnknownException; WebserviceException

createDocumentFromTemplate

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,
                                    DatabaseException,
                                    DocumentException,
                                    TemplateException,
                                    DocumentTemplateException,
                                    ConversionException,
                                    UnsupportedMimeTypeException,
                                    FileSizeExceededException,
                                    UserQuotaExceededException,
                                    VirusDetectedException,
                                    ItemExistsException,
                                    AutomationException,
                                    FilePlanException,
                                    PromotedAsRecordLockException,
                                    ParseException,
                                    NoSuchGroupException,
                                    NoSuchPropertyException,
                                    LockException,
                                    ValidationFormException,
                                    ClassNotFoundException,
                                    UnknownException,
                                    WebserviceException

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

updateDocumentFromTemplate

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

Throws:: DocumentException; TemplateException; DocumentTemplateException; ConversionException; FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; LockException; VersionException; PathNotFoundException; ParseException; AccessDeniedException; RepositoryException; DatabaseException; AutomationException; PromotedAsRecordLockException; NoSuchGroupException; NoSuchPropertyException; ValidationFormException; ClassNotFoundException; UnknownException; WebserviceException

getAnnotations

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

Throws:: AccessDeniedException; PathNotFoundException; DatabaseException; UnknownException; WebserviceException

getDifferences

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

Throws:: RepositoryException; AccessDeniedException; PathNotFoundException; DatabaseException; AutomationException; ConversionException; TemplateException; InterruptedException; WebserviceException; UnknownException

getCheckedOut

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

Throws:: AccessDeniedException; PathNotFoundException; RepositoryException; DatabaseException; WebserviceException; UnknownException

setDocumentDispositionStage

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

Throws:: PathNotFoundException; AccessDeniedException; DatabaseException; WebserviceException; UnknownException

setDocumentDescription

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

Throws:: LockException; VersionException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; PromotedAsRecordLockException; WebserviceException; UnknownException

createWizardDocument

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

Throws:: UnsupportedMimeTypeException; FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; ExtensionException; AutomationException; PromotedAsRecordLockException; UnknownException; WebserviceException

isOCRDataCaptureSupported

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

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

recognize

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

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

captureData

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

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

getNumberOfPages

int getNumberOfPages(String uuid)
              throws AccessDeniedException,
                     RepositoryException,
                     DatabaseException,
                     PathNotFoundException,
                     WebserviceException,
                     UnknownException,
                     PrincipalAdapterException

Throws:: AccessDeniedException; RepositoryException; DatabaseException; PathNotFoundException; WebserviceException; UnknownException; PrincipalAdapterException

getPageAsImage

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

Throws:: AccessDeniedException; RepositoryException; DatabaseException; PathNotFoundException; WebserviceException; UnknownException; PrincipalAdapterException

mergePdf

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

Throws:: AccessDeniedException; RepositoryException; DatabaseException; PathNotFoundException; WebserviceException; UnknownException; PrincipalAdapterException

getDocumentPdf

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

Throws:: PathNotFoundException; AccessDeniedException; ConversionException; AutomationException; RepositoryException; DatabaseException; UnknownException; WebserviceException

saveDocumentAsPdf

Document saveDocumentAsPdf(String uuid,
                           String newName)
                    throws RepositoryException,
                           AccessDeniedException,
                           PathNotFoundException,
                           DatabaseException,
                           IOException,
                           ConversionException,
                           UnsupportedMimeTypeException,
                           VirusDetectedException,
                           ItemExistsException,
                           AutomationException,
                           PromotedAsRecordLockException,
                           PrincipalAdapterException,
                           UnknownException,
                           WebserviceException

Throws:: RepositoryException; AccessDeniedException; PathNotFoundException; DatabaseException; IOException; ConversionException; UnsupportedMimeTypeException; VirusDetectedException; ItemExistsException; AutomationException; PromotedAsRecordLockException; PrincipalAdapterException; UnknownException; WebserviceException

getLiveEditRestrictedMimeTypes

List<String> getLiveEditRestrictedMimeTypes()
                                     throws WebserviceException,
                                            UnknownException

Throws:: WebserviceException; UnknownException

liveEditCheckin

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

Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; LockException; DatabaseException; AutomationException; PromotedAsRecordLockException; UnknownException; WebserviceException

liveEditSetContent

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

Throws:: AutomationException; AccessDeniedException; RepositoryException; PathNotFoundException; LockException; DatabaseException; ExtensionException; PromotedAsRecordLockException; UnknownException; WebserviceException

isAttachment

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

Throws:: PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

isConvertibleToPDF

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

Throws:: PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

Interface BaseDocument

Method Summary

Method Detail

createDocument

createDocument

createDocument

deleteDocument

getDocumentProperties

getContent

getContentByVersion

getDocumentChildren

renameDocument

setProperties

setLanguage

setDocumentTitle

setDocumentNodeClass

checkout

cancelCheckout

forceCancelCheckout

isCheckedOut

checkin

checkin

lockDocument

forceLockDocument

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

getDocumentPdf

saveDocumentAsPdf

getLiveEditRestrictedMimeTypes

liveEditCheckin

liveEditSetContent

isAttachment

isConvertibleToPDF