Package com.openkm.sdk4j.definition
Interface BaseDocument
-
- All Known Implementing Classes:
DocumentImpl
public interface BaseDocumentBaseDocument- Author:
- sochoa
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description voidcancelCheckout(String uuid)Cancel a previous checked out state in a document.voidcaptureData(String uuid, long templateId)Proceed to the OCR data capture using OCR template identified by templateId.Versioncheckin(String uuid, InputStream is, String comment)Check in the document to create a new version.Versioncheckin(String uuid, InputStream is, String comment, int increment)Check in the document to create a new version.voidcheckout(String uuid)Checkout the document to edit it.Documentcopy(String uuid, String dstId, String newName)Copy a document to another location in the repository.Documentcreate(String uuid, File file)Creates a new documentDocumentcreate(String uuid, String name, InputStream is)Creates a new documentDocumentcreate(String uuid, String name, InputStream is, long nodeClass)Creates a new documentDocumentcreateFromTemplate(String uuid, String dstPath, boolean categories, boolean keywords, boolean notes, boolean security, Map<String,String> properties)Create from template document.DocumentcreateFromTemplate(String uuid, String dstPath, boolean categories, boolean keywords, boolean notes, Map<String,String> properties)Deprecated.WizardNodecreateWizard(String uuid, String name, long nodeClass, InputStream is)Create a new document with wizard.voiddelete(String uuid)Deletes a document from the repository.DocumentextendedCopy(String uuid, String dstId, String newName, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean security)Copy a document to another location in the repository.voidforceCancelCheckout(String uuid)Force to cancel a previous checked out state in a document.StringgetAnnotations(String uuid, String versionName)Get annotations for documentList<Document>getCheckedOut()Get checked out documentsList<Document>getChildren(String uuid)Gets children.InputStreamgetContent(String uuid)Obtain document content from the repository.InputStreamgetContentByVersion(String uuid, String versionName)Obtain document content from the repository.List<String>getDetectedLanguages()Retrieve a list of language.InputStreamgetDifferences(String uuid, String versionName1, String versionName2)Get differences between two document versions.StringgetExtractedText(String uuid)Obtain the document extracted text.intgetNumberOfPages(String uuid)Get the number of pages of a document.StringgetPageAsImage(String uuid, int pageNumber, int maxWidth, int maxHeight)Get page as image.StringgetPath(String uuid)Get the document path from a UUIDInputStreamgetPdf(String uuid)PDF of the document.DocumentgetProperties(String uuid)Obtain document properties from the repository.InputStreamgetThumbnail(String uuid, ThumbnailType type)Returns thumbnail image data.longgetVersionHistorySize(String uuid)Get the versions size of a Document.List<XRef>getXrefs(String uuid)Returns a list of the document references of a Autocad documentbooleanisAttachment(String uuid)Indicates if the node is a mail attachment or not.booleanisCheckedOut(String uuid)Test if a node has been already checked out.booleanisConvertibleToPDF(String uuid)Is convertible to pdfbooleanisOCRDataCaptureSupported(String uuid)Check if the node supports an OCR data capture.booleanisValid(String uuid)Test if a document path exists and is readable.voidliveEditCancelCheckout(String uuid)Live edit cancel checkout.voidliveEditCheckin(String uuid, String comment, int increment)It does a live edit checkin.voidliveEditForceCancelCheckout(String uuid)Live edit force cancel checkout.voidliveEditSetContent(String uuid, InputStream is)Update the content of the document edited with live edit feature.StringmergePdf(String dstId, String docName, List<String> uuids)Merge PDF documents.voidmove(String uuid, String dstId)Move a document to another location in the repository.voidpurge(String uuid)Deletes definitively a document from the repository.OCRRecogniserecognize(String uuid)Recognizevoidrefresh(String uuid)Refresh references of an Autocad documentDocumentrename(String uuid, String newName)Rename a document in the repository.DocumentsaveAsPdf(String uuid, String newName, boolean propertyGroups, boolean security)Save the document as PDF in the OpenKM repository.voidsetDescription(String uuid, String description)Set document description.voidsetDispositionStage(String uuid, long stage)Set disposition stagevoidsetExtractedText(String uuid, InputStream is)Sets extracted text.voidsetIndexable(String uuid, boolean enabled)Sets indexable.voidsetLanguage(String uuid, String lang)Set document language.voidsetNodeClass(String uuid, long nodeClass)Set document node classvoidsetProperties(String uuid, String title, String description, String lang, List<String> keywords, List<String> categories)Set document properties in the repository.voidsetTitle(String uuid, String title)Set document title.voidstamp(String uuid, int type, long stampId)Stamp.voidupdateFromTemplate(String uuid, String dstId, Map<String,String> properties)Update from templatevoidwebPageImport(String uuid, String url)Web page import.
-
-
-
Method Detail
-
create
Document create(String uuid, File file) throws UnsupportedMimeTypeException, FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, PromotedAsRecordLockException, UnknownException, WebserviceException
Creates a new document- Parameters:
uuid- Node uuid.file- The document content in bytes.- Returns:
- Document Return an object Document with the properties of the created document.
- Throws:
UnsupportedMimeTypeException- the unsupported mime type 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 exception
-
create
Document create(String uuid, String name, InputStream is) throws UnsupportedMimeTypeException, FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, PromotedAsRecordLockException, UnknownException, WebserviceException
Creates a new document- Parameters:
uuid- Node uuid.name- The nane documentis- The document content in bytes.- Returns:
- Document Return an object Document with the properties of the created document.
- Throws:
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 exception
-
create
Document create(String uuid, String name, InputStream is, long nodeClass) throws UnsupportedMimeTypeException, FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, PromotedAsRecordLockException, UnknownException, WebserviceException
Creates a new document- Parameters:
uuid- Node uuid.name- The name documentis- The document content in bytes.nodeClass- the node class- Returns:
- Document Return an object Document with the properties of the created document.
- Throws:
UnsupportedMimeTypeException- the unsupported mime type 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 exception
-
delete
void delete(String uuid) throws AutomationException, AccessDeniedException, RepositoryException, PathNotFoundException, LockException, DatabaseException, ExtensionException, PromotedAsRecordLockException, UnknownException, WebserviceException
Deletes a document from the repository. It is a logical delete, so really is moved to the user trash and can be restored.- Parameters:
uuid- Node uuid- Throws:
AutomationException- 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 exception
-
getProperties
Document getProperties(String uuid) throws AccessDeniedException, RepositoryException, PathNotFoundException, DatabaseException, UnknownException, WebserviceException
Obtain document properties from the repository.- Parameters:
uuid- Node uuid- Returns:
- Document The document properties.
- Throws:
AccessDeniedException- the access denied exceptionRepositoryException- the repository exceptionPathNotFoundException- the path not found exceptionDatabaseException- the database exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exception
-
getContent
InputStream getContent(String uuid) throws RepositoryException, PathNotFoundException, AccessDeniedException, DatabaseException, UnknownException, WebserviceException
Obtain document content from the repository.- Parameters:
uuid- Node uuid- Returns:
- InputStream The content of the document file.
- Throws:
RepositoryException- the repository exceptionPathNotFoundException- the path not found exceptionAccessDeniedException- the access denied exceptionDatabaseException- the database exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exception
-
getContentByVersion
InputStream getContentByVersion(String uuid, String versionName) throws RepositoryException, PathNotFoundException, AccessDeniedException, DatabaseException, UnknownException, WebserviceException
Obtain document content from the repository.- Parameters:
uuid- Node uuidversionName- The name of the version to get the content from.- Returns:
- InputStream The content of the document file.
- Throws:
RepositoryException- the repository exceptionPathNotFoundException- the path not found exceptionAccessDeniedException- the access denied exceptionDatabaseException- the database exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exception
-
getExtractedText
String getExtractedText(String uuid) throws AccessDeniedException, RepositoryException, PathNotFoundException, DatabaseException, UnknownException, WebserviceException
Obtain the document extracted text.- Parameters:
uuid- Node uuid- Returns:
- Returns the text of the document.
- Throws:
AccessDeniedException- the access denied exceptionRepositoryException- the repository exceptionPathNotFoundException- the path not found exceptionDatabaseException- the database exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exception
-
setExtractedText
void setExtractedText(String uuid, InputStream is) throws AccessDeniedException, PathNotFoundException, DatabaseException, UnknownException, WebserviceException
Sets extracted text.- Parameters:
uuid- the uuidis- the is- Throws:
AccessDeniedException- the access denied exceptionPathNotFoundException- the path not found exceptionDatabaseException- the database exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exception
-
getThumbnail
InputStream getThumbnail(String uuid, ThumbnailType type) throws PathNotFoundException, AccessDeniedException, ConversionException, AutomationException, RepositoryException, DatabaseException, UnknownException, WebserviceException
Returns thumbnail image data.- Parameters:
uuid- Node uuidtype-ThumbnailType- Returns:
- Returns thumbnail image data.
- Throws:
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 exception
-
getChildren
List<Document> getChildren(String uuid) throws AccessDeniedException, RepositoryException, PathNotFoundException, DatabaseException, UnknownException, WebserviceException
Gets children.- Parameters:
uuid- the uuid- Returns:
- the children
- Throws:
AccessDeniedException- the access denied exceptionRepositoryException- the repository exceptionPathNotFoundException- the path not found exceptionDatabaseException- the database exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exception
-
rename
Document rename(String uuid, String newName) throws AccessDeniedException, RepositoryException, PathNotFoundException, ItemExistsException, LockException, DatabaseException, ExtensionException, PromotedAsRecordLockException, AutomationException, UnknownException, WebserviceException
Rename a document in the repository.- Parameters:
uuid- Node uuidnewName- The new document name.- Returns:
- Document An document object with the new document properties.
- Throws:
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 exception
-
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
Set document properties in the repository.- Parameters:
uuid- Node uuidtitle- the titledescription- the descriptionlang- the langkeywords- the keywordscategories- the categories- Throws:
AccessDeniedException- 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 exception
-
setLanguage
void setLanguage(String uuid, String lang) throws VersionException, LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, PromotedAsRecordLockException, UnknownException, WebserviceException
Set document language.- Parameters:
uuid- Node uuidlang- The language- Throws:
VersionException- 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 exception
-
setTitle
void setTitle(String uuid, String title) throws VersionException, LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, PromotedAsRecordLockException, UnknownException, WebserviceException
Set document title.- Parameters:
uuid- Node uuidtitle- The title- Throws:
VersionException- 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 exception
-
setNodeClass
void setNodeClass(String uuid, long nodeClass) throws VersionException, LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, PromotedAsRecordLockException, UnknownException, WebserviceException
Set document node class- Parameters:
uuid- Node uuidnodeClass- The nodeClass id- Throws:
VersionException- 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 exception
-
setDispositionStage
void setDispositionStage(String uuid, long stage) throws PathNotFoundException, AccessDeniedException, DatabaseException, WebserviceException, UnknownException
Set disposition stage- Parameters:
uuid- Node uuidstage- the stage- Throws:
PathNotFoundException- the path not found exceptionAccessDeniedException- the access denied exceptionDatabaseException- the database exceptionWebserviceException- the webservice exceptionUnknownException- the unknown exception
-
checkout
void checkout(String uuid) throws AccessDeniedException, RepositoryException, PathNotFoundException, LockException, DatabaseException, UnknownException, WebserviceException
Checkout the document to edit it. The document can't be edited by another user until it is checked in o the checkout is canceled.- Parameters:
uuid- Node uuid- Throws:
AccessDeniedException- the access denied exceptionRepositoryException- the repository exceptionPathNotFoundException- the path not found exceptionLockException- the lock exceptionDatabaseException- the database exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exception
-
cancelCheckout
void cancelCheckout(String uuid) throws AccessDeniedException, RepositoryException, PathNotFoundException, LockException, DatabaseException, UnknownException, WebserviceException
Cancel a previous checked out state in a document.- Parameters:
uuid- Node uuid- Throws:
AccessDeniedException- the access denied exceptionRepositoryException- the repository exceptionPathNotFoundException- the path not found exceptionLockException- the lock exceptionDatabaseException- the database exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exception
-
forceCancelCheckout
void forceCancelCheckout(String uuid) throws AccessDeniedException, RepositoryException, PathNotFoundException, LockException, DatabaseException, AuthException, UnknownException, WebserviceException
Force to cancel a previous checked out state in a document.- Parameters:
uuid- Node uuid- Throws:
AccessDeniedException- the access denied exceptionRepositoryException- the repository exceptionPathNotFoundException- the path not found exceptionLockException- the lock exceptionDatabaseException- the database exceptionAuthException- the principal adapter exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exception
-
isCheckedOut
boolean isCheckedOut(String uuid) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException, UnknownException, WebserviceException
Test if a node has been already checked out.- Parameters:
uuid- Node uuid- Returns:
- true if the document is in checked out state, or false if not.
- Throws:
AccessDeniedException- the access denied exceptionPathNotFoundException- the path not found exceptionRepositoryException- the repository exceptionDatabaseException- the database exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exception
-
checkin
Version checkin(String uuid, InputStream is, String comment) throws FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, PromotedAsRecordLockException, UnknownException, WebserviceException
Check in the document to create a new version.- Parameters:
uuid- Node uuidis- The document content in bytes.comment- A comment for this checkin.- Returns:
- Version A version object with the properties of the new generated version.
- Throws:
FileSizeExceededException- the file size exceeded 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
-
checkin
Version checkin(String uuid, InputStream is, String comment, int increment) throws FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, PromotedAsRecordLockException, UnknownException, WebserviceException
Check in the document to create a new version.- Parameters:
uuid- Node uuidis- The document content in bytes.comment- A comment for this checkin.increment- Which increment should be increased.- Returns:
- Version A version object with the properties of the new generated version.
- Throws:
FileSizeExceededException- the file size exceeded 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
-
purge
void purge(String uuid) throws LockException, AccessDeniedException, RepositoryException, PathNotFoundException, DatabaseException, ExtensionException, PromotedAsRecordLockException, UnknownException, WebserviceException
Deletes definitively a document from the repository. It is a physical delete, so the document can't be restored.- Parameters:
uuid- Node uuid- Throws:
LockException- 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 exception
-
move
void move(String uuid, String dstId) throws LockException, PathNotFoundException, ItemExistsException, AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, PromotedAsRecordLockException, FilePlanCatalogManagerException, VersionException, UnknownException, WebserviceException
Move a document to another location in the repository.- Parameters:
uuid- Node uuiddstId- The destination folder path or its UUID.- Throws:
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 exception
-
copy
Document copy(String uuid, String dstId, String newName) throws ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, UserQuotaExceededException, ExtensionException, AutomationException, PromotedAsRecordLockException, UnknownException, WebserviceException
Copy a document to another location in the repository.- Parameters:
uuid- Node uuiddstId- The destination folder path or its UUID.newName- The new name to the document- Returns:
- Document An object document
- Throws:
ItemExistsException- 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 exception
-
getVersionHistorySize
long getVersionHistorySize(String uuid) throws AccessDeniedException, RepositoryException, PathNotFoundException, DatabaseException, UnknownException, WebserviceException
Get the versions size of a Document.- Parameters:
uuid- Node uuid- Returns:
- long The version size of a Document.
- Throws:
AccessDeniedException- the access denied exceptionRepositoryException- the repository exceptionPathNotFoundException- the path not found exceptionDatabaseException- the database exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exception
-
isValid
boolean isValid(String uuid) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException, UnknownException, WebserviceException
Test if a document path exists and is readable.- Parameters:
uuid- Node uuid- Returns:
- True if is a valid document path, otherwise false.
- Throws:
AccessDeniedException- the access denied exceptionPathNotFoundException- the path not found exceptionRepositoryException- the repository exceptionDatabaseException- the database exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exception
-
getPath
String getPath(String uuid) throws AccessDeniedException, RepositoryException, DatabaseException, UnknownException, WebserviceException
Get the document path from a UUID- Parameters:
uuid- Node uuid- Returns:
- The document path
- Throws:
AccessDeniedException- the access denied exceptionRepositoryException- the repository exceptionDatabaseException- the database exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exception
-
getDetectedLanguages
List<String> getDetectedLanguages() throws AccessDeniedException, RepositoryException, DatabaseException, UnknownException, WebserviceException
Retrieve a list of language.- Returns:
- List
The list detected languages - Throws:
AccessDeniedException- the access denied exceptionRepositoryException- the repository exceptionDatabaseException- the database exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exception
-
extendedCopy
Document extendedCopy(String uuid, String dstId, String newName, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean security) throws ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, UserQuotaExceededException, AutomationException, PromotedAsRecordLockException, UnknownException, WebserviceException
Copy a document to another location in the repository.- Parameters:
uuid- Node uuid.dstId- The destination folder path or its UUID.newName- The new document name.categories- The categorieskeywords- The keywordspropertyGroups- The propertyGroupsnotes- The notessecurity- The security- Returns:
- An object document
- Throws:
ItemExistsException- 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
-
createFromTemplate
Document createFromTemplate(String uuid, String dstPath, boolean categories, boolean keywords, boolean notes, boolean security, Map<String,String> properties) throws PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, DocumentException, TemplateException, DocumentTemplateException, ConversionException, UnsupportedMimeTypeException, FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, ItemExistsException, AutomationException, FilePlanException, PromotedAsRecordLockException, ParseException, NoSuchGroupException, NoSuchPropertyException, LockException, ValidationFormException, ClassNotFoundException, UnknownException, WebserviceException
Create from template document.- Parameters:
uuid- the uuiddstPath- the dst pathcategories- the categorieskeywords- the keywordsnotes- the notessecurity- the securityproperties- the properties- Returns:
- the document
- Throws:
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
-
createFromTemplate
@Deprecated Document createFromTemplate(String uuid, String dstPath, boolean categories, boolean keywords, boolean notes, Map<String,String> properties) throws PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, DocumentException, TemplateException, DocumentTemplateException, ConversionException, UnsupportedMimeTypeException, FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, ItemExistsException, AutomationException, FilePlanException, PromotedAsRecordLockException, ParseException, NoSuchGroupException, NoSuchPropertyException, LockException, ValidationFormException, ClassNotFoundException, UnknownException, WebserviceException
Deprecated.Create from template- Parameters:
uuid- Node uuiddstPath- The destination folder pathcategories- The categorieskeywords- The keywordsnotes- The notesproperties- The property values.- Returns:
- An object Document
- Throws:
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
-
updateFromTemplate
void updateFromTemplate(String uuid, String dstId, Map<String,String> properties) throws DocumentException, TemplateException, DocumentTemplateException, ConversionException, FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, LockException, PathNotFoundException, ParseException, AccessDeniedException, RepositoryException, DatabaseException, AutomationException, PromotedAsRecordLockException, NoSuchGroupException, NoSuchPropertyException, ValidationFormException, ClassNotFoundException, UnknownException, WebserviceException
Update from template- Parameters:
uuid- Node uuiddstId- The destination folder pathproperties- The property values.- Throws:
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 exception
-
getAnnotations
String getAnnotations(String uuid, String versionName) throws AccessDeniedException, PathNotFoundException, DatabaseException, UnknownException, WebserviceException
Get annotations for document- Parameters:
uuid- Node uuidversionName- The name of the version- Returns:
- Returns annotations
- Throws:
AccessDeniedException- the access denied exceptionPathNotFoundException- the path not found exceptionDatabaseException- the database exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exception
-
getDifferences
InputStream getDifferences(String uuid, String versionName1, String versionName2) throws RepositoryException, AccessDeniedException, PathNotFoundException, DatabaseException, AutomationException, ConversionException, TemplateException, InterruptedException, WebserviceException, UnknownException
Get differences between two document versions.- Parameters:
uuid- Node uuidversionName1- The name of the versionversionName2- The name of the version- Returns:
- Return a PDF document with the differences between two document versions.
- Throws:
RepositoryException- 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 exception
-
getCheckedOut
List<Document> getCheckedOut() throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException, WebserviceException, UnknownException
Get checked out documents- Returns:
- The list of checked out documents.
- Throws:
AccessDeniedException- the access denied exceptionPathNotFoundException- the path not found exceptionRepositoryException- the repository exceptionDatabaseException- the database exceptionWebserviceException- the webservice exceptionUnknownException- the unknown exception
-
stamp
void stamp(String uuid, int type, long stampId) throws RepositoryException, AccessDeniedException, PathNotFoundException, DatabaseException, AutomationException, UnsupportedMimeTypeException, PromotedAsRecordLockException, LockException, DocumentException, NumberFormatException, AuthException, WebserviceException, UnknownException
Stamp.- Parameters:
uuid- the uuidtype- the typestampId- the stamp id- Throws:
RepositoryException- the repository exceptionAccessDeniedException- the access denied exceptionPathNotFoundException- the path not found exceptionDatabaseException- the database exceptionAutomationException- the automation exceptionUnsupportedMimeTypeException- the unsupported mime type exceptionPromotedAsRecordLockException- the promoted as record lock exceptionLockException- the lock exceptionDocumentException- the document exceptionNumberFormatException- the number format exceptionAuthException- the principal adapter exceptionWebserviceException- the webservice exceptionUnknownException- the unknown exception
-
setDescription
void setDescription(String uuid, String description) throws LockException, VersionException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, PromotedAsRecordLockException, WebserviceException, UnknownException
Set document description.- Parameters:
uuid- Node uuiddescription- The description- Throws:
LockException- 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 exception
-
createWizard
WizardNode createWizard(String uuid, String name, long nodeClass, InputStream is) throws UnsupportedMimeTypeException, FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, PromotedAsRecordLockException, UnknownException, WebserviceException
Create a new document with wizard.- Parameters:
uuid- Node uuidname- The document name.nodeClass- The nodeClassis- The document content in bytes.- Returns:
- An object WizardName
- Throws:
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 exception
-
isOCRDataCaptureSupported
boolean isOCRDataCaptureSupported(String uuid) throws UnsupportedMimeTypeException, FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, UnknownException, WebserviceException
Check if the node supports an OCR data capture.- Parameters:
uuid- Node uuid- Returns:
- true if have OCR data capture supported, or false if not.
- Throws:
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 exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exception
-
recognize
OCRRecognise recognize(String uuid) throws UnsupportedMimeTypeException, FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, UnknownException, WebserviceException
Recognize- Parameters:
uuid- Node uuid- Returns:
- Return an OCRRecognise object.
- Throws:
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 exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exception
-
captureData
void captureData(String uuid, long templateId) throws UnsupportedMimeTypeException, FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, UnknownException, WebserviceException
Proceed to the OCR data capture using OCR template identified by templateId.- Parameters:
uuid- Node uuidtemplateId- The template id- Throws:
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 exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exception
-
getNumberOfPages
int getNumberOfPages(String uuid) throws AccessDeniedException, RepositoryException, DatabaseException, WebserviceException, UnknownException, AuthException
Get the number of pages of a document.- Parameters:
uuid- Node uuid- Returns:
- Returns the number of pages of a document
- Throws:
AccessDeniedException- the access denied exceptionRepositoryException- the repository exceptionDatabaseException- the database exceptionWebserviceException- the webservice exceptionUnknownException- the unknown exceptionAuthException- the principal adapter exception
-
getPageAsImage
String getPageAsImage(String uuid, int pageNumber, int maxWidth, int maxHeight) throws AccessDeniedException, RepositoryException, DatabaseException, PathNotFoundException, WebserviceException, UnknownException, AuthException
Get page as image.- Parameters:
uuid- Node uuidpageNumber- The page numbermaxWidth- The maximum widthmaxHeight- The maximum height- Returns:
- Return specific page as an image encoded as a String in b64.
- Throws:
AccessDeniedException- the access denied exceptionRepositoryException- the repository exceptionDatabaseException- the database exceptionPathNotFoundException- the path not found exceptionWebserviceException- the webservice exceptionUnknownException- the unknown exceptionAuthException- the principal adapter exception
-
mergePdf
String mergePdf(String dstId, String docName, List<String> uuids) throws AccessDeniedException, RepositoryException, DatabaseException, WebserviceException, UnknownException, AuthException
Merge PDF documents.- Parameters:
dstId- the destination uuiddocName- the doc nameuuids- the uuids- Returns:
- the uuid of the PDF
- Throws:
AccessDeniedException- the access denied exceptionRepositoryException- the repository exceptionDatabaseException- the database exceptionWebserviceException- the webservice exceptionUnknownException- the unknown exceptionAuthException- the principal adapter exception
-
getPdf
InputStream getPdf(String uuid) throws PathNotFoundException, AccessDeniedException, ConversionException, AutomationException, RepositoryException, DatabaseException, UnknownException, WebserviceException
PDF of the document.- Parameters:
uuid- Node uuid- Returns:
- Returns a PDF of the document.
- Throws:
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 exception
-
saveAsPdf
Document saveAsPdf(String uuid, String newName, boolean propertyGroups, boolean security) throws RepositoryException, AccessDeniedException, PathNotFoundException, DatabaseException, ConversionException, UnsupportedMimeTypeException, VirusDetectedException, ItemExistsException, AutomationException, PromotedAsRecordLockException, AuthException, UnknownException, WebserviceException
Save the document as PDF in the OpenKM repository.- Parameters:
uuid- Node uuidnewName- The new name to the documentpropertyGroups- the property groupssecurity- the security- Returns:
- An object document
- Throws:
RepositoryException- 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 exceptionAuthException- the principal adapter exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exception
-
liveEditCheckin
void liveEditCheckin(String uuid, String comment, int increment) throws AccessDeniedException, RepositoryException, PathNotFoundException, LockException, DatabaseException, AutomationException, PromotedAsRecordLockException, UnknownException, WebserviceException
It does a live edit checkin.- Parameters:
uuid- Node uuidcomment- A comment for this checkin.increment- Which increment should be increased.- Throws:
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 exception
-
liveEditCancelCheckout
void liveEditCancelCheckout(String uuid) throws AccessDeniedException, RepositoryException, PathNotFoundException, LockException, DatabaseException, UnknownException, WebserviceException
Live edit cancel checkout.- Parameters:
uuid- the uuid- Throws:
AccessDeniedException- the access denied exceptionRepositoryException- the repository exceptionPathNotFoundException- the path not found exceptionLockException- the lock exceptionDatabaseException- the database exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exception
-
liveEditForceCancelCheckout
void liveEditForceCancelCheckout(String uuid) throws AccessDeniedException, RepositoryException, PathNotFoundException, LockException, DatabaseException, AuthException, UnknownException, WebserviceException
Live edit force cancel checkout.- Parameters:
uuid- the uuid- Throws:
AccessDeniedException- the access denied exceptionRepositoryException- the repository exceptionPathNotFoundException- the path not found exceptionLockException- the lock exceptionDatabaseException- the database exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exceptionAuthException
-
liveEditSetContent
void liveEditSetContent(String uuid, InputStream is) throws AutomationException, AccessDeniedException, RepositoryException, PathNotFoundException, LockException, DatabaseException, PromotedAsRecordLockException, UnknownException, WebserviceException
Update the content of the document edited with live edit feature.- Parameters:
uuid- Node uuidis- The document content in bytes.- Throws:
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 exception
-
isAttachment
boolean isAttachment(String uuid) throws PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, UnknownException, WebserviceException
Indicates if the node is a mail attachment or not.- Parameters:
uuid- Node uuid- Returns:
- Returns a boolean that indicates if the node is a mail attachment or not.
- Throws:
PathNotFoundException- the path not found exceptionAccessDeniedException- the access denied exceptionRepositoryException- the repository exceptionDatabaseException- the database exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exception
-
isConvertibleToPDF
boolean isConvertibleToPDF(String uuid) throws PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, UnknownException, WebserviceException
Is convertible to pdf- Parameters:
uuid- Node uuid- Returns:
- Returns a boolean that indicates if the node is convertible to PDF or not.
- Throws:
PathNotFoundException- the path not found exceptionAccessDeniedException- the access denied exceptionRepositoryException- the repository exceptionDatabaseException- the database exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exception
-
webPageImport
void webPageImport(String uuid, String url) throws ConversionException, UnknownException, WebserviceException
Web page import.- Parameters:
uuid- the uuidurl- the url- Throws:
ConversionException- the conversion exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exception
-
setIndexable
void setIndexable(String uuid, boolean enabled) throws AccessDeniedException, RepositoryException, PathNotFoundException, LockException, DatabaseException, PromotedAsRecordLockException, UnknownException, WebserviceException
Sets indexable.- Parameters:
uuid- the uuidenabled- the enabled- Throws:
AccessDeniedException- 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 exception
-
getXrefs
List<XRef> getXrefs(String uuid) throws RepositoryException, AccessDeniedException, PathNotFoundException, DatabaseException, UnknownException, WebserviceException
Returns a list of the document references of a Autocad document- Parameters:
uuid- Node uuid- Returns:
- List
xrefs - Throws:
RepositoryException- the repository exceptionAccessDeniedException- the access denied exceptionPathNotFoundException- the path not found exceptionDatabaseException- the database exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exception
-
refresh
void refresh(String uuid) throws DatabaseException, PathNotFoundException, AccessDeniedException, RepositoryException, ParseException, UnknownException, WebserviceException
Refresh references of an Autocad document- Parameters:
uuid- Node uuid- Throws:
DatabaseException- the database exceptionPathNotFoundException- the path not found exceptionAccessDeniedException- the access denied exceptionRepositoryException- the repository exceptionParseException- the parse exceptionUnknownException- the unknown exceptionWebserviceException- the webservice exception
-
-