public interface BaseDocument
Modifier and Type | Method and Description |
---|---|
void |
cancelCheckout(String uuid)
Cancel a previous checked out state in a document.
|
void |
captureData(String uuid,
long templateId)
Proceed to the OCR data capture using OCR template identified by templateId.
|
Version |
checkin(String uuid,
InputStream is,
String comment)
Check in the document to create a new version.
|
Version |
checkin(String uuid,
InputStream is,
String comment,
int increment)
Check in the document to create a new version.
|
void |
checkout(String uuid)
Checkout the document to edit it.
|
Document |
copyDocument(String uuid,
String dstId,
String newName)
Copy a document to another location in the repository.
|
Document |
createDocument(String uuid,
File file)
Creates a new document
|
Document |
createDocument(String uuid,
String name,
InputStream is)
Creates a new document
|
Document |
createDocument(String uuid,
String name,
InputStream is,
long nodeClass)
Creates a new document
|
Document |
createDocumentFromTemplate(String uuid,
String dstPath,
boolean categories,
boolean keywords,
boolean notes,
Map<String,String> properties)
Create from template
|
Document |
createDocumentFromTemplate(String uuid,
String dstPath,
String language,
boolean categories,
boolean keywords,
boolean propertyGroups,
boolean notes,
boolean wiki,
Map<String,String> properties)
Deprecated.
|
Document |
createDocumentFromTemplate(String uuid,
String dstPath,
String language,
boolean categories,
boolean keywords,
boolean notes,
Map<String,String> properties)
Deprecated.
|
WizardNode |
createWizardDocument(String uuid,
String name,
long nodeClass,
InputStream is)
Create a new document with wizard.
|
void |
deleteDocument(String uuid)
Deletes a document from the repository.
|
Document |
extendedDocumentCopy(String uuid,
String dstId,
String name,
boolean categories,
boolean keywords,
boolean propertyGroups,
boolean notes,
boolean security)
Copy a document to another location in the repository.
|
Document |
extendedDocumentCopy(String uuid,
String dstId,
String name,
boolean categories,
boolean keywords,
boolean propertyGroups,
boolean notes,
boolean wiki,
boolean security)
Deprecated.
|
void |
forceCancelCheckout(String uuid)
Force to cancel a previous checked out state in a document.
|
LockInfo |
forceLockDocument(String uuid)
Deprecated.
|
void |
forceUnlockDocument(String uuid)
Force node unlock, so will be editable for other users.
|
String |
getAnnotations(String uuid,
String versionName)
Get annotations for document
|
List<Document> |
getCheckedOut()
Get checked out documents
|
InputStream |
getContent(String uuid)
Obtain document content from the repository.
|
InputStream |
getContentByVersion(String uuid,
String versionName)
Obtain document content from the repository.
|
List<String> |
getDetectedLanguages()
Retrieve a list of language.
|
InputStream |
getDifferences(String uuid,
String versionName1,
String versionName2)
Get differences between two document versions.
|
List<Document> |
getDocumentChildren(String fldId)
Retrieve a list of children documents from an existing folder.
|
String |
getDocumentPath(String uuid)
Get the document path from a UUID
|
InputStream |
getDocumentPdf(String uuid)
PDF of the document.
|
Document |
getDocumentProperties(String uuid)
Obtain document properties from the repository.
|
String |
getExtractedText(String uuid)
Obtain the document extracted text.
|
List<String> |
getLiveEditRestrictedMimeTypes()
Get mymetypes what can not be used with liveedit feature.
|
LockInfo |
getLockInfo(String uuid)
Returns a lock information.
|
int |
getNumberOfPages(String uuid)
Get the number of pages of a document.
|
String |
getPageAsImage(String uuid,
int pageNumber,
int maxWidth,
int maxHeight)
Get page as image.
|
InputStream |
getThumbnail(String uuid,
ThumbnailType type)
Returns thumbnail image data.
|
long |
getVersionHistorySize(String uuid)
Get the versions size of a Document.
|
boolean |
isAttachment(String uuid)
Indicates if the node is a mail attachment or not.
|
boolean |
isCheckedOut(String uuid)
Test if a node has been already checked out.
|
boolean |
isConvertibleToPDF(String uuid)
Is convertible to pdf
|
boolean |
isLocked(String uuid)
Tell if a node is locked.
|
boolean |
isOCRDataCaptureSupported(String uuid)
Check if the node supports an OCR data capture.
|
boolean |
isValidDocument(String uuid)
Test if a document path exists and is readable.
|
void |
liveEditCheckin(String uuid,
String comment,
int increment)
It does a live edit checkin.
|
void |
liveEditSetContent(String uuid,
InputStream is)
Update the content of the document edited with live edit feature.
|
LockInfo |
lockDocument(String uuid)
Deprecated.
|
void |
mergePdf(String destinationUuid,
String docName,
List<String> uuids)
Merge two or more PDF files.
|
void |
moveDocument(String uuid,
String dstId)
Move a document to another location in the repository.
|
void |
purgeDocument(String uuid)
Deletes definitively a document from the repository.
|
OCRRecognise |
recognize(String uuid)
Recognize
|
Document |
renameDocument(String uuid,
String newName)
Rename a document in the repository.
|
Document |
saveDocumentAsPdf(String uuid,
String newName)
Save the document as PDF in the OpenKM repository.
|
void |
setDocumentDescription(String uuid,
String description)
Set document description.
|
void |
setDocumentDispositionStage(String uuid,
long stage)
Set disposition stage
|
void |
setDocumentNodeClass(String uuid,
long ncId)
Set document node class
|
void |
setDocumentTitle(String uuid,
String title)
Set document title.
|
void |
setLanguage(String uuid,
String lang)
Set document language.
|
void |
setProperties(String uuid,
String title,
String description,
String lang,
List<String> keywords,
List<String> categories)
Set document properties in the repository.
|
void |
unlockDocument(String uuid)
Unlock a node, so will be editable for other users.
|
void |
updateDocumentFromTemplate(String uuid,
String dstId,
Map<String,String> properties)
Update from template
|
void |
webPageImport(String uuid,
String url)
Web page import.
|
Document createDocument(String uuid, File file) throws UnsupportedMimeTypeException, FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, PromotedAsRecordLockException, UnknownException, WebserviceException
uuid
- Node uuid.file
- The document content in bytes.UnsupportedMimeTypeException
- the unsupported mime type exceptionFileSizeExceededException
- the file size exceeded exceptionUserQuotaExceededException
- the user quota exceeded exceptionVirusDetectedException
- the virus detected exceptionItemExistsException
- the item exists exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionExtensionException
- the extension exceptionAutomationException
- the automation exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionDocument createDocument(String uuid, String name, InputStream is) throws UnsupportedMimeTypeException, FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, PromotedAsRecordLockException, UnknownException, WebserviceException
uuid
- Node uuid.name
- The nane documentis
- The document content in bytes.UnsupportedMimeTypeException
- the unsupported mime type exceptionFileSizeExceededException
- the file size exceeded exceptionUserQuotaExceededException
- the user quota exceeded exceptionVirusDetectedException
- the virus detected exceptionItemExistsException
- the item exists exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionExtensionException
- the extension exceptionAutomationException
- the automation exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionDocument createDocument(String uuid, String name, InputStream is, long nodeClass) throws UnsupportedMimeTypeException, FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, PromotedAsRecordLockException, UnknownException, WebserviceException
uuid
- Node uuid.name
- The name documentis
- The document content in bytes.nodeClass
- the node classUnsupportedMimeTypeException
- the unsupported mime type exceptionFileSizeExceededException
- the file size exceeded exceptionUserQuotaExceededException
- the user quota exceeded exceptionVirusDetectedException
- the virus detected exceptionItemExistsException
- the item exists exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionExtensionException
- the extension exceptionAutomationException
- the automation exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionvoid deleteDocument(String uuid) throws AutomationException, AccessDeniedException, RepositoryException, PathNotFoundException, LockException, DatabaseException, ExtensionException, PromotedAsRecordLockException, UnknownException, WebserviceException
uuid
- Node uuidAutomationException
- the automation exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionPathNotFoundException
- the path not found exceptionLockException
- the lock exceptionDatabaseException
- the database exceptionExtensionException
- the extension exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionDocument getDocumentProperties(String uuid) throws AccessDeniedException, RepositoryException, PathNotFoundException, DatabaseException, UnknownException, WebserviceException
uuid
- Node uuidAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionPathNotFoundException
- the path not found exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionInputStream getContent(String uuid) throws RepositoryException, PathNotFoundException, AccessDeniedException, DatabaseException, UnknownException, WebserviceException
uuid
- Node uuidRepositoryException
- the repository exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionInputStream getContentByVersion(String uuid, String versionName) throws RepositoryException, PathNotFoundException, AccessDeniedException, DatabaseException, UnknownException, WebserviceException
uuid
- Node uuidversionName
- The name of the version to get the content from.RepositoryException
- the repository exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionList<Document> getDocumentChildren(String fldId) throws AccessDeniedException, RepositoryException, PathNotFoundException, DatabaseException, UnknownException, WebserviceException
fldId
- Node uuidAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionPathNotFoundException
- the path not found exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionDocument renameDocument(String uuid, String newName) throws AccessDeniedException, RepositoryException, PathNotFoundException, ItemExistsException, LockException, DatabaseException, ExtensionException, PromotedAsRecordLockException, AutomationException, UnknownException, WebserviceException
uuid
- Node uuidnewName
- The new document name.AccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionPathNotFoundException
- the path not found exceptionItemExistsException
- the item exists exceptionLockException
- the lock exceptionDatabaseException
- the database exceptionExtensionException
- the extension exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionAutomationException
- the automation exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionvoid 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
uuid
- Node uuidtitle
- the titledescription
- the descriptionlang
- the langkeywords
- the keywordscategories
- the categoriesAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionPathNotFoundException
- the path not found exceptionVersionException
- the version exceptionLockException
- the lock exceptionDatabaseException
- the database exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionvoid setLanguage(String uuid, String lang) throws VersionException, LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, PromotedAsRecordLockException, UnknownException, WebserviceException
uuid
- Node uuidlang
- The languageVersionException
- the version exceptionLockException
- the lock exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionvoid setDocumentTitle(String uuid, String title) throws VersionException, LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, PromotedAsRecordLockException, UnknownException, WebserviceException
uuid
- Node uuidtitle
- The titleVersionException
- the version exceptionLockException
- the lock exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionvoid setDocumentNodeClass(String uuid, long ncId) throws VersionException, LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, PromotedAsRecordLockException, UnknownException, WebserviceException
uuid
- Node uuidncId
- The nodeClass idVersionException
- the version exceptionLockException
- the lock exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionvoid checkout(String uuid) throws AccessDeniedException, RepositoryException, PathNotFoundException, LockException, DatabaseException, UnknownException, WebserviceException
uuid
- Node uuidAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionPathNotFoundException
- the path not found exceptionLockException
- the lock exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionvoid cancelCheckout(String uuid) throws AccessDeniedException, RepositoryException, PathNotFoundException, LockException, DatabaseException, UnknownException, WebserviceException
uuid
- Node uuidAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionPathNotFoundException
- the path not found exceptionLockException
- the lock exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionvoid forceCancelCheckout(String uuid) throws AccessDeniedException, RepositoryException, PathNotFoundException, LockException, DatabaseException, PrincipalAdapterException, UnknownException, WebserviceException
uuid
- Node uuidAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionPathNotFoundException
- the path not found exceptionLockException
- the lock exceptionDatabaseException
- the database exceptionPrincipalAdapterException
- the principal adapter exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionboolean isCheckedOut(String uuid) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException, UnknownException, WebserviceException
uuid
- Node uuidAccessDeniedException
- the access denied exceptionPathNotFoundException
- the path not found exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionVersion checkin(String uuid, InputStream is, String comment) throws FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, PromotedAsRecordLockException, UnknownException, WebserviceException
uuid
- Node uuidis
- The document content in bytes.comment
- A comment for this checkin.FileSizeExceededException
- the file size exceeded exceptionUserQuotaExceededException
- the user quota exceeded exceptionVirusDetectedException
- the virus detected exceptionLockException
- the lock exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionExtensionException
- the extension exceptionAutomationException
- the automation exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionVersion checkin(String uuid, InputStream is, String comment, int increment) throws FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, PromotedAsRecordLockException, UnknownException, WebserviceException
uuid
- Node uuidis
- The document content in bytes.comment
- A comment for this checkin.increment
- Which increment should be increased.FileSizeExceededException
- the file size exceeded exceptionUserQuotaExceededException
- the user quota exceeded exceptionVirusDetectedException
- the virus detected exceptionLockException
- the lock exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionExtensionException
- the extension exceptionAutomationException
- the automation exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exception@Deprecated LockInfo lockDocument(String uuid) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, UnknownException, WebserviceException
uuid
- Node uuidLockException
- the lock exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exception@Deprecated LockInfo forceLockDocument(String uuid) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, UnknownException, WebserviceException
uuid
- Node uuidLockException
- the lock exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionvoid unlockDocument(String uuid) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, UnknownException, WebserviceException
uuid
- Node uuidLockException
- the lock exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionvoid forceUnlockDocument(String uuid) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, UnknownException, WebserviceException
uuid
- Node uuidLockException
- the lock exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionboolean isLocked(String uuid) throws AccessDeniedException, RepositoryException, PathNotFoundException, DatabaseException, UnknownException, WebserviceException
uuid
- Node uuidAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionPathNotFoundException
- the path not found exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionLockInfo getLockInfo(String uuid) throws AccessDeniedException, RepositoryException, PathNotFoundException, LockException, DatabaseException, UnknownException, WebserviceException
uuid
- Node uuidAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionPathNotFoundException
- the path not found exceptionLockException
- the lock exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionvoid purgeDocument(String uuid) throws LockException, AccessDeniedException, RepositoryException, PathNotFoundException, DatabaseException, ExtensionException, PromotedAsRecordLockException, UnknownException, WebserviceException
uuid
- Node uuidLockException
- the lock exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionPathNotFoundException
- the path not found exceptionDatabaseException
- the database exceptionExtensionException
- the extension exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionvoid moveDocument(String uuid, String dstId) throws LockException, PathNotFoundException, ItemExistsException, AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, PromotedAsRecordLockException, FilePlanCatalogManagerException, VersionException, UnknownException, WebserviceException
uuid
- Node uuiddstId
- The destination folder path or its UUID.LockException
- the lock exceptionPathNotFoundException
- the path not found exceptionItemExistsException
- the item exists exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionExtensionException
- the extension exceptionAutomationException
- the automation exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionFilePlanCatalogManagerException
- the file plan catalog manager exceptionVersionException
- the version exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionDocument copyDocument(String uuid, String dstId, String newName) throws ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, UserQuotaExceededException, ExtensionException, AutomationException, PromotedAsRecordLockException, UnknownException, WebserviceException
uuid
- Node uuiddstId
- The destination folder path or its UUID.newName
- The new name to the documentItemExistsException
- the item exists exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionUserQuotaExceededException
- the user quota exceeded exceptionExtensionException
- the extension exceptionAutomationException
- the automation exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionlong getVersionHistorySize(String uuid) throws AccessDeniedException, RepositoryException, PathNotFoundException, DatabaseException, UnknownException, WebserviceException
uuid
- Node uuidAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionPathNotFoundException
- the path not found exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionboolean isValidDocument(String uuid) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException, UnknownException, WebserviceException
uuid
- Node uuidAccessDeniedException
- the access denied exceptionPathNotFoundException
- the path not found exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionString getDocumentPath(String uuid) throws AccessDeniedException, RepositoryException, DatabaseException, UnknownException, WebserviceException
uuid
- Node uuidAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionList<String> getDetectedLanguages() throws AccessDeniedException, RepositoryException, DatabaseException, UnknownException, WebserviceException
AccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionDocument extendedDocumentCopy(String uuid, String dstId, String name, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean security) throws ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, UserQuotaExceededException, AutomationException, PromotedAsRecordLockException, UnknownException, WebserviceException
uuid
- Node uuid.dstId
- The destination folder path or its UUID.name
- The new document name.categories
- The categorieskeywords
- The keywordspropertyGroups
- The propertyGroupsnotes
- The notessecurity
- The securityItemExistsException
- the item exists exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionUserQuotaExceededException
- the user quota exceeded exceptionAutomationException
- the automation exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exception@Deprecated Document extendedDocumentCopy(String uuid, 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
uuid
- Node uuid.dstId
- The destination folder path or its UUID.name
- The new document name.categories
- The categorieskeywords
- The keywordspropertyGroups
- The propertyGroupsnotes
- The noteswiki
- The wikisecurity
- The securityItemExistsException
- the item exists exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionUserQuotaExceededException
- the user quota exceeded exceptionAutomationException
- the automation exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionString getExtractedText(String uuid) throws AccessDeniedException, RepositoryException, PathNotFoundException, DatabaseException, UnknownException, WebserviceException
uuid
- Node uuidAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionPathNotFoundException
- the path not found exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionInputStream getThumbnail(String uuid, ThumbnailType type) throws PathNotFoundException, AccessDeniedException, ConversionException, AutomationException, RepositoryException, DatabaseException, UnknownException, WebserviceException
uuid
- Node uuidtype
- ThumbnailType
PathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionConversionException
- the conversion exceptionAutomationException
- the automation exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionDocument createDocumentFromTemplate(String uuid, String dstPath, boolean categories, boolean keywords, boolean notes, Map<String,String> properties) throws PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, DocumentException, TemplateException, DocumentTemplateException, ConversionException, UnsupportedMimeTypeException, FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, ItemExistsException, AutomationException, FilePlanException, PromotedAsRecordLockException, ParseException, NoSuchGroupException, NoSuchPropertyException, LockException, ValidationFormException, ClassNotFoundException, UnknownException, WebserviceException
uuid
- Node uuiddstPath
- The destination folder pathcategories
- The categorieskeywords
- The keywordsnotes
- The notesproperties
- The property values.PathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionDocumentException
- the document exceptionTemplateException
- the template exceptionDocumentTemplateException
- the document template exceptionConversionException
- the conversion exceptionUnsupportedMimeTypeException
- the unsupported mime type exceptionFileSizeExceededException
- the file size exceeded exceptionUserQuotaExceededException
- the user quota exceeded exceptionVirusDetectedException
- the virus detected exceptionItemExistsException
- the item exists exceptionAutomationException
- the automation exceptionFilePlanException
- the file plan exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionParseException
- the parse exceptionNoSuchGroupException
- the no such group exceptionNoSuchPropertyException
- the no such property exceptionLockException
- the lock exceptionValidationFormException
- the validation form exceptionClassNotFoundException
- the class not found exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exception@Deprecated Document createDocumentFromTemplate(String uuid, String dstPath, String language, boolean categories, boolean keywords, boolean notes, Map<String,String> properties) throws PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, DocumentException, TemplateException, DocumentTemplateException, ConversionException, UnsupportedMimeTypeException, FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, ItemExistsException, AutomationException, FilePlanException, PromotedAsRecordLockException, ParseException, NoSuchGroupException, NoSuchPropertyException, LockException, ValidationFormException, ClassNotFoundException, UnknownException, WebserviceException
uuid
- Node uuiddstPath
- The destination folder pathlanguage
- The languagecategories
- The categorieskeywords
- The keywordsnotes
- The notesproperties
- The property values.PathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionDocumentException
- the document exceptionTemplateException
- the template exceptionDocumentTemplateException
- the document template exceptionConversionException
- the conversion exceptionUnsupportedMimeTypeException
- the unsupported mime type exceptionFileSizeExceededException
- the file size exceeded exceptionUserQuotaExceededException
- the user quota exceeded exceptionVirusDetectedException
- the virus detected exceptionItemExistsException
- the item exists exceptionAutomationException
- the automation exceptionFilePlanException
- the file plan exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionParseException
- the parse exceptionNoSuchGroupException
- the no such group exceptionNoSuchPropertyException
- the no such property exceptionLockException
- the lock exceptionValidationFormException
- the validation form exceptionClassNotFoundException
- the class not found exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exception@Deprecated 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
uuid
- Node uuiddstPath
- The destination folder pathlanguage
- The languagecategories
- The categorieskeywords
- The keywordspropertyGroups
- The property groupsnotes
- The noteswiki
- The wikiproperties
- The property values.PathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionDocumentException
- the document exceptionTemplateException
- the template exceptionDocumentTemplateException
- the document template exceptionConversionException
- the conversion exceptionUnsupportedMimeTypeException
- the unsupported mime type exceptionFileSizeExceededException
- the file size exceeded exceptionUserQuotaExceededException
- the user quota exceeded exceptionVirusDetectedException
- the virus detected exceptionItemExistsException
- the item exists exceptionAutomationException
- the automation exceptionFilePlanException
- the file plan exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionParseException
- the parse exceptionNoSuchGroupException
- the no such group exceptionNoSuchPropertyException
- the no such property exceptionLockException
- the lock exceptionValidationFormException
- the validation form exceptionClassNotFoundException
- the class not found exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionvoid updateDocumentFromTemplate(String uuid, String dstId, Map<String,String> properties) throws DocumentException, TemplateException, DocumentTemplateException, ConversionException, FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, LockException, PathNotFoundException, ParseException, AccessDeniedException, RepositoryException, DatabaseException, AutomationException, PromotedAsRecordLockException, NoSuchGroupException, NoSuchPropertyException, ValidationFormException, ClassNotFoundException, UnknownException, WebserviceException
uuid
- Node uuiddstId
- The destination folder pathproperties
- The property values.DocumentException
- the document exceptionTemplateException
- the template exceptionDocumentTemplateException
- the document template exceptionConversionException
- the conversion exceptionFileSizeExceededException
- the file size exceeded exceptionUserQuotaExceededException
- the user quota exceeded exceptionVirusDetectedException
- the virus detected exceptionLockException
- the lock exceptionPathNotFoundException
- the path not found exceptionParseException
- the parse exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionAutomationException
- the automation exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionNoSuchGroupException
- the no such group exceptionNoSuchPropertyException
- the no such property exceptionValidationFormException
- the validation form exceptionClassNotFoundException
- the class not found exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionString getAnnotations(String uuid, String versionName) throws AccessDeniedException, PathNotFoundException, DatabaseException, UnknownException, WebserviceException
uuid
- Node uuidversionName
- The name of the versionAccessDeniedException
- the access denied exceptionPathNotFoundException
- the path not found exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionInputStream getDifferences(String uuid, String versionName1, String versionName2) throws RepositoryException, AccessDeniedException, PathNotFoundException, DatabaseException, AutomationException, ConversionException, TemplateException, InterruptedException, WebserviceException, UnknownException
uuid
- Node uuidversionName1
- The name of the versionversionName2
- The name of the versionRepositoryException
- the repository exceptionAccessDeniedException
- the access denied exceptionPathNotFoundException
- the path not found exceptionDatabaseException
- the database exceptionAutomationException
- the automation exceptionConversionException
- the conversion exceptionTemplateException
- the template exceptionInterruptedException
- the interrupted exceptionWebserviceException
- the webservice exceptionUnknownException
- the unknown exceptionList<Document> getCheckedOut() throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException, WebserviceException, UnknownException
AccessDeniedException
- the access denied exceptionPathNotFoundException
- the path not found exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionWebserviceException
- the webservice exceptionUnknownException
- the unknown exceptionvoid setDocumentDispositionStage(String uuid, long stage) throws PathNotFoundException, AccessDeniedException, DatabaseException, WebserviceException, UnknownException
uuid
- Node uuidstage
- the stagePathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionDatabaseException
- the database exceptionWebserviceException
- the webservice exceptionUnknownException
- the unknown exceptionvoid setDocumentDescription(String uuid, String description) throws LockException, VersionException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, PromotedAsRecordLockException, WebserviceException, UnknownException
uuid
- Node uuiddescription
- The descriptionLockException
- the lock exceptionVersionException
- the version exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionWebserviceException
- the webservice exceptionUnknownException
- the unknown exceptionWizardNode createWizardDocument(String uuid, String name, long nodeClass, InputStream is) throws UnsupportedMimeTypeException, FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, PromotedAsRecordLockException, UnknownException, WebserviceException
uuid
- Node uuidname
- The document name.nodeClass
- The nodeClassis
- The document content in bytes.UnsupportedMimeTypeException
- the unsupported mime type exceptionFileSizeExceededException
- the file size exceeded exceptionUserQuotaExceededException
- the user quota exceeded exceptionVirusDetectedException
- the virus detected exceptionItemExistsException
- the item exists exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionExtensionException
- the extension exceptionAutomationException
- the automation exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionboolean isOCRDataCaptureSupported(String uuid) throws UnsupportedMimeTypeException, FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, UnknownException, WebserviceException
uuid
- Node uuidUnsupportedMimeTypeException
- the unsupported mime type exceptionFileSizeExceededException
- the file size exceeded exceptionUserQuotaExceededException
- the user quota exceeded exceptionVirusDetectedException
- the virus detected exceptionItemExistsException
- the item exists exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionExtensionException
- the extension exceptionAutomationException
- the automation exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionOCRRecognise recognize(String uuid) throws UnsupportedMimeTypeException, FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, UnknownException, WebserviceException
uuid
- Node uuidUnsupportedMimeTypeException
- the unsupported mime type exceptionFileSizeExceededException
- the file size exceeded exceptionUserQuotaExceededException
- the user quota exceeded exceptionVirusDetectedException
- the virus detected exceptionItemExistsException
- the item exists exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionExtensionException
- the extension exceptionAutomationException
- the automation exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionvoid captureData(String uuid, long templateId) throws UnsupportedMimeTypeException, FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, UnknownException, WebserviceException
uuid
- Node uuidtemplateId
- The template idUnsupportedMimeTypeException
- the unsupported mime type exceptionFileSizeExceededException
- the file size exceeded exceptionUserQuotaExceededException
- the user quota exceeded exceptionVirusDetectedException
- the virus detected exceptionItemExistsException
- the item exists exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionExtensionException
- the extension exceptionAutomationException
- the automation exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionint getNumberOfPages(String uuid) throws AccessDeniedException, RepositoryException, DatabaseException, PathNotFoundException, WebserviceException, UnknownException, PrincipalAdapterException
uuid
- Node uuidAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionPathNotFoundException
- the path not found exceptionWebserviceException
- the webservice exceptionUnknownException
- the unknown exceptionPrincipalAdapterException
- the principal adapter exceptionString getPageAsImage(String uuid, int pageNumber, int maxWidth, int maxHeight) throws AccessDeniedException, RepositoryException, DatabaseException, PathNotFoundException, WebserviceException, UnknownException, PrincipalAdapterException
uuid
- Node uuidpageNumber
- The page numbermaxWidth
- The maximum widthmaxHeight
- The maximum heightAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionPathNotFoundException
- the path not found exceptionWebserviceException
- the webservice exceptionUnknownException
- the unknown exceptionPrincipalAdapterException
- the principal adapter exceptionvoid mergePdf(String destinationUuid, String docName, List<String> uuids) throws AccessDeniedException, RepositoryException, DatabaseException, PathNotFoundException, WebserviceException, UnknownException, PrincipalAdapterException
destinationUuid
- the destination uuiddocName
- The nome documentuuids
- The collections uuidsAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionPathNotFoundException
- the path not found exceptionWebserviceException
- the webservice exceptionUnknownException
- the unknown exceptionPrincipalAdapterException
- the principal adapter exceptionInputStream getDocumentPdf(String uuid) throws PathNotFoundException, AccessDeniedException, ConversionException, AutomationException, RepositoryException, DatabaseException, UnknownException, WebserviceException
uuid
- Node uuidPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionConversionException
- the conversion exceptionAutomationException
- the automation exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionDocument saveDocumentAsPdf(String uuid, String newName) throws RepositoryException, AccessDeniedException, PathNotFoundException, DatabaseException, ConversionException, UnsupportedMimeTypeException, VirusDetectedException, ItemExistsException, AutomationException, PromotedAsRecordLockException, PrincipalAdapterException, UnknownException, WebserviceException
uuid
- Node uuidnewName
- The new name to the documentRepositoryException
- the repository exceptionAccessDeniedException
- the access denied exceptionPathNotFoundException
- the path not found exceptionDatabaseException
- the database exceptionConversionException
- the conversion exceptionUnsupportedMimeTypeException
- the unsupported mime type exceptionVirusDetectedException
- the virus detected exceptionItemExistsException
- the item exists exceptionAutomationException
- the automation exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionPrincipalAdapterException
- the principal adapter exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionList<String> getLiveEditRestrictedMimeTypes() throws WebserviceException, UnknownException
WebserviceException
- the webservice exceptionUnknownException
- the unknown exceptionvoid liveEditCheckin(String uuid, String comment, int increment) throws AccessDeniedException, RepositoryException, PathNotFoundException, LockException, DatabaseException, AutomationException, PromotedAsRecordLockException, UnknownException, WebserviceException
uuid
- Node uuidcomment
- A comment for this checkin.increment
- Which increment should be increased.AccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionPathNotFoundException
- the path not found exceptionLockException
- the lock exceptionDatabaseException
- the database exceptionAutomationException
- the automation exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionvoid liveEditSetContent(String uuid, InputStream is) throws AutomationException, AccessDeniedException, RepositoryException, PathNotFoundException, LockException, DatabaseException, PromotedAsRecordLockException, UnknownException, WebserviceException
uuid
- Node uuidis
- The document content in bytes.AutomationException
- the automation exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionPathNotFoundException
- the path not found exceptionLockException
- the lock exceptionDatabaseException
- the database exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionboolean isAttachment(String uuid) throws PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, UnknownException, WebserviceException
uuid
- Node uuidPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionboolean isConvertibleToPDF(String uuid) throws PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, UnknownException, WebserviceException
uuid
- Node uuidPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionvoid webPageImport(String uuid, String url) throws ConversionException, UnknownException, WebserviceException
uuid
- the uuidurl
- the urlUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionConversionException
Copyright © 2021 Open Knowledge Management System S.L.. All Rights Reserved.