Package com.openkm.sdk4j.definition

Interface BaseDocument

All Known Implementing Classes:

DocumentImpl

public interface BaseDocument

BaseDocument

Author:

sochoa

Method Summary

Modifier and Type	Method	Description
void	cancelCheckout(String uuid)	Cancel a previous checked out state in a document.
void	captureData(String uuid, long templateId)	Proceed to the OCR data capture using OCR template identified by templateId.
Version	checkin(String uuid, InputStream is, String comment)	Check in the document to create a new version.
Version	checkin(String uuid, InputStream is, String comment, int increment)	Check in the document to create a new version.
void	checkout(String uuid)	Checkout the document to edit it.
Document	copy(String uuid, String dstId, String newName)	Copy a document to another location in the repository.
Document	create(String uuid, File file)	Creates a new document
Document	create(String uuid, String name, InputStream is)	Creates a new document
Document	create(String uuid, String name, InputStream is, long nodeClass)	Creates a new document
Document	createFromTemplate(String uuid, String dstPath, boolean categories, boolean keywords, boolean notes, boolean security, Map<String,String> properties)	Create from template document.
Document	createFromTemplate(String uuid, String dstPath, boolean categories, boolean keywords, boolean notes, Map<String,String> properties)	Deprecated.
WizardNode	createWizard(String uuid, String name, long nodeClass, InputStream is)	Create a new document with wizard.
void	delete(String uuid)	Deletes a document from the repository.
Document	extendedCopy(String uuid, String dstId, String newName, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean security)	Copy a document to another location in the repository.
void	forceCancelCheckout(String uuid)	Force to cancel a previous checked out state in a document.
String	getAnnotations(String uuid, String versionName)	Get annotations for document
List<Document>	getCheckedOut()	Get checked out documents
List<Document>	getChildren(String uuid)	Gets children.
InputStream	getContent(String uuid)	Obtain document content from the repository.
InputStream	getContentByVersion(String uuid, String versionName)	Obtain document content from the repository.
List<String>	getDetectedLanguages()	Retrieve a list of language.
InputStream	getDifferences(String uuid, String versionName1, String versionName2)	Get differences between two document versions.
String	getExtractedText(String uuid)	Obtain the document extracted text.
int	getNumberOfPages(String uuid)	Get the number of pages of a document.
String	getPageAsImage(String uuid, int pageNumber, int maxWidth, int maxHeight)	Get page as image.
String	getPath(String uuid)	Get the document path from a UUID
InputStream	getPdf(String uuid)	PDF of the document.
Document	getProperties(String uuid)	Obtain document properties from the repository.
InputStream	getThumbnail(String uuid, ThumbnailType type)	Returns thumbnail image data.
long	getVersionHistorySize(String uuid)	Get the versions size of a Document.
List<XRef>	getXrefs(String uuid)	Returns a list of the document references of a Autocad document
boolean	isAttachment(String uuid)	Indicates if the node is a mail attachment or not.
boolean	isCheckedOut(String uuid)	Test if a node has been already checked out.
boolean	isConvertibleToPDF(String uuid)	Is convertible to pdf
boolean	isOCRDataCaptureSupported(String uuid)	Check if the node supports an OCR data capture.
boolean	isValid(String uuid)	Test if a document path exists and is readable.
void	liveEditCancelCheckout(String uuid)	Live edit cancel checkout.
void	liveEditCheckin(String uuid, String comment, int increment)	It does a live edit checkin.
void	liveEditForceCancelCheckout(String uuid)	Live edit force cancel checkout.
void	liveEditSetContent(String uuid, InputStream is)	Update the content of the document edited with live edit feature.
String	mergePdf(String dstId, String docName, List<String> uuids)	Merge PDF documents.
void	move(String uuid, String dstId)	Move a document to another location in the repository.
void	purge(String uuid)	Deletes definitively a document from the repository.
OCRRecognise	recognize(String uuid)	Recognize
void	refresh(String uuid)	Refresh references of an Autocad document
Document	rename(String uuid, String newName)	Rename a document in the repository.
Document	saveAsPdf(String uuid, String newName, boolean propertyGroups, boolean security)	Save the document as PDF in the OpenKM repository.
void	setDescription(String uuid, String description)	Set document description.
void	setDispositionStage(String uuid, long stage)	Set disposition stage
void	setExtractedText(String uuid, InputStream is)	Sets extracted text.
void	setIndexable(String uuid, boolean enabled)	Sets indexable.
void	setLanguage(String uuid, String lang)	Set document language.
void	setNodeClass(String uuid, long nodeClass)	Set document node class
void	setProperties(String uuid, String title, String description, String lang, List<String> keywords, List<String> categories)	Set document properties in the repository.
void	setTitle(String uuid, String title)	Set document title.
void	stamp(String uuid, int type, long stampId)	Stamp.
void	updateFromTemplate(String uuid, String dstId, Map<String,String> properties)	Update from template
void	webPageImport(String uuid, String url)	Web page import.

Method Details

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 exception

FileSizeExceededException - the file size exceeded exception

UserQuotaExceededException - the user quota exceeded exception

VirusDetectedException - the virus detected exception

ItemExistsException - the item exists exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

ExtensionException - the extension exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

create

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 document

is - The document content in bytes.

Returns:

Document Return an object Document with the properties of the created document.

Throws:

UnsupportedMimeTypeException - the unsupported mime type exception

FileSizeExceededException - the file size exceeded exception

UserQuotaExceededException - the user quota exceeded exception

VirusDetectedException - the virus detected exception

ItemExistsException - the item exists exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

ExtensionException - the extension exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

create

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 document

is - The document content in bytes.

nodeClass - the node class

Returns:

Document Return an object Document with the properties of the created document.

Throws:

UnsupportedMimeTypeException - the unsupported mime type exception

FileSizeExceededException - the file size exceeded exception

UserQuotaExceededException - the user quota exceeded exception

VirusDetectedException - the virus detected exception

ItemExistsException - the item exists exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

ExtensionException - the extension exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

delete

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 exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

LockException - the lock exception

DatabaseException - the database exception

ExtensionException - the extension exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getProperties

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 exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - 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 exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getContentByVersion

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

Obtain document content from the repository.

Parameters:

uuid - Node uuid

versionName - The name of the version to get the content from.

Returns:

InputStream The content of the document file.

Throws:

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getExtractedText

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 exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

setExtractedText

void setExtractedText(String uuid,
 InputStream is)
               throws AccessDeniedException,
PathNotFoundException,
DatabaseException,
UnknownException,
WebserviceException

Sets extracted text.

Parameters:

uuid - the uuid

is - the is

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getThumbnail

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

Returns thumbnail image data.

Parameters:

uuid - Node uuid

type - ThumbnailType

Returns:

Returns thumbnail image data.

Throws:

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

ConversionException - the conversion exception

AutomationException - the automation exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getChildren

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 exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - 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 uuid

newName - The new document name.

Returns:

Document An document object with the new document properties.

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

ItemExistsException - the item exists exception

LockException - the lock exception

DatabaseException - the database exception

ExtensionException - the extension exception

PromotedAsRecordLockException - the promoted as record lock exception

AutomationException - the automation exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

setProperties

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 uuid

title - the title

description - the description

lang - the lang

keywords - the keywords

categories - the categories

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

VersionException - the version exception

LockException - the lock exception

DatabaseException - the database exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

setLanguage

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

Set document language.

Parameters:

uuid - Node uuid

lang - The language

Throws:

VersionException - the version exception

LockException - the lock exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

setTitle

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

Set document title.

Parameters:

uuid - Node uuid

title - The title

Throws:

VersionException - the version exception

LockException - the lock exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

setNodeClass

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

Set document node class

Parameters:

uuid - Node uuid

nodeClass - The nodeClass id

Throws:

VersionException - the version exception

LockException - the lock exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

setDispositionStage

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

Set disposition stage

Parameters:

uuid - Node uuid

stage - the stage

Throws:

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

DatabaseException - the database exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

checkout

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 exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

LockException - the lock exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

cancelCheckout

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 exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

LockException - the lock exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

forceCancelCheckout

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 exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

LockException - the lock exception

DatabaseException - the database exception

AuthException - the principal adapter exception

UnknownException - the unknown exception

WebserviceException - 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 exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - 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 uuid

is - The document content in bytes.

comment - A comment for this checkin.

Returns:

Version A version object with the properties of the new generated version.

Throws:

FileSizeExceededException - the file size exceeded exception

UserQuotaExceededException - the user quota exceeded exception

VirusDetectedException - the virus detected exception

LockException - the lock exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

ExtensionException - the extension exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

checkin

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 uuid

is - The document content in bytes.

comment - A comment for this checkin.

increment - Which increment should be increased.

Returns:

Version A version object with the properties of the new generated version.

Throws:

FileSizeExceededException - the file size exceeded exception

UserQuotaExceededException - the user quota exceeded exception

VirusDetectedException - the virus detected exception

LockException - the lock exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

ExtensionException - the extension exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

purge

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 exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

ExtensionException - the extension exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

move

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 uuid

dstId - The destination folder path or its UUID.

Throws:

LockException - the lock exception

PathNotFoundException - the path not found exception

ItemExistsException - the item exists exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

ExtensionException - the extension exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

FilePlanCatalogManagerException - the file plan catalog manager exception

VersionException - the version exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

copy

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 uuid

dstId - The destination folder path or its UUID.

newName - The new name to the document

Returns:

Document An object document

Throws:

ItemExistsException - the item exists exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UserQuotaExceededException - the user quota exceeded exception

ExtensionException - the extension exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getVersionHistorySize

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 exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - 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 exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - 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 exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - 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 exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - 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 categories

keywords - The keywords

propertyGroups - The propertyGroups

notes - The notes

security - The security

Returns:

An object document

Throws:

ItemExistsException - the item exists exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UserQuotaExceededException - the user quota exceeded exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

createFromTemplate

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 uuid

dstPath - the dst path

categories - the categories

keywords - the keywords

notes - the notes

security - the security

properties - the properties

Returns:

the document

Throws:

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

DocumentException - the document exception

TemplateException - the template exception

DocumentTemplateException - the document template exception

ConversionException - the conversion exception

UnsupportedMimeTypeException - the unsupported mime type exception

FileSizeExceededException - the file size exceeded exception

UserQuotaExceededException - the user quota exceeded exception

VirusDetectedException - the virus detected exception

ItemExistsException - the item exists exception

AutomationException - the automation exception

FilePlanException - the file plan exception

PromotedAsRecordLockException - the promoted as record lock exception

ParseException - the parse exception

NoSuchGroupException - the no such group exception

NoSuchPropertyException - the no such property exception

LockException - the lock exception

ValidationFormException - the validation form exception

ClassNotFoundException - the class not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

createFromTemplate

@Deprecated
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 uuid

dstPath - The destination folder path

categories - The categories

keywords - The keywords

notes - The notes

properties - The property values.

Returns:

An object Document

Throws:

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

DocumentException - the document exception

TemplateException - the template exception

DocumentTemplateException - the document template exception

ConversionException - the conversion exception

UnsupportedMimeTypeException - the unsupported mime type exception

FileSizeExceededException - the file size exceeded exception

UserQuotaExceededException - the user quota exceeded exception

VirusDetectedException - the virus detected exception

ItemExistsException - the item exists exception

AutomationException - the automation exception

FilePlanException - the file plan exception

PromotedAsRecordLockException - the promoted as record lock exception

ParseException - the parse exception

NoSuchGroupException - the no such group exception

NoSuchPropertyException - the no such property exception

LockException - the lock exception

ValidationFormException - the validation form exception

ClassNotFoundException - the class not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

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 uuid

dstId - The destination folder path

properties - The property values.

Throws:

DocumentException - the document exception

TemplateException - the template exception

DocumentTemplateException - the document template exception

ConversionException - the conversion exception

FileSizeExceededException - the file size exceeded exception

UserQuotaExceededException - the user quota exceeded exception

VirusDetectedException - the virus detected exception

LockException - the lock exception

PathNotFoundException - the path not found exception

ParseException - the parse exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

NoSuchGroupException - the no such group exception

NoSuchPropertyException - the no such property exception

ValidationFormException - the validation form exception

ClassNotFoundException - the class not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getAnnotations

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

Get annotations for document

Parameters:

uuid - Node uuid

versionName - The name of the version

Returns:

Returns annotations

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getDifferences

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 uuid

versionName1 - The name of the version

versionName2 - The name of the version

Returns:

Return a PDF document with the differences between two document versions.

Throws:

RepositoryException - the repository exception

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AutomationException - the automation exception

ConversionException - the conversion exception

TemplateException - the template exception

InterruptedException - the interrupted exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getCheckedOut

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 exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

WebserviceException - the webservice exception

UnknownException - 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 uuid

type - the type

stampId - the stamp id

Throws:

RepositoryException - the repository exception

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AutomationException - the automation exception

UnsupportedMimeTypeException - the unsupported mime type exception

PromotedAsRecordLockException - the promoted as record lock exception

LockException - the lock exception

DocumentException - the document exception

NumberFormatException - the number format exception

AuthException - the principal adapter exception

WebserviceException - the webservice exception

UnknownException - 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 uuid

description - The description

Throws:

LockException - the lock exception

VersionException - the version exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PromotedAsRecordLockException - the promoted as record lock exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

createWizard

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 uuid

name - The document name.

nodeClass - The nodeClass

is - The document content in bytes.

Returns:

An object WizardName

Throws:

UnsupportedMimeTypeException - the unsupported mime type exception

FileSizeExceededException - the file size exceeded exception

UserQuotaExceededException - the user quota exceeded exception

VirusDetectedException - the virus detected exception

ItemExistsException - the item exists exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

ExtensionException - the extension exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

isOCRDataCaptureSupported

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 exception

FileSizeExceededException - the file size exceeded exception

UserQuotaExceededException - the user quota exceeded exception

VirusDetectedException - the virus detected exception

ItemExistsException - the item exists exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

ExtensionException - the extension exception

AutomationException - the automation exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

recognize

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 exception

FileSizeExceededException - the file size exceeded exception

UserQuotaExceededException - the user quota exceeded exception

VirusDetectedException - the virus detected exception

ItemExistsException - the item exists exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

ExtensionException - the extension exception

AutomationException - the automation exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

captureData

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 uuid

templateId - The template id

Throws:

UnsupportedMimeTypeException - the unsupported mime type exception

FileSizeExceededException - the file size exceeded exception

UserQuotaExceededException - the user quota exceeded exception

VirusDetectedException - the virus detected exception

ItemExistsException - the item exists exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

ExtensionException - the extension exception

AutomationException - the automation exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getNumberOfPages

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 exception

RepositoryException - the repository exception

DatabaseException - the database exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

AuthException - 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 uuid

pageNumber - The page number

maxWidth - The maximum width

maxHeight - The maximum height

Returns:

Return specific page as an image encoded as a String in b64.

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

AuthException - 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 uuid

docName - the doc name

uuids - the uuids

Returns:

the uuid of the PDF

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

AuthException - 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 exception

AccessDeniedException - the access denied exception

ConversionException - the conversion exception

AutomationException - the automation exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

saveAsPdf

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 uuid

newName - The new name to the document

propertyGroups - the property groups

security - the security

Returns:

An object document

Throws:

RepositoryException - the repository exception

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

ConversionException - the conversion exception

UnsupportedMimeTypeException - the unsupported mime type exception

VirusDetectedException - the virus detected exception

ItemExistsException - the item exists exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

AuthException - the principal adapter exception

UnknownException - the unknown exception

WebserviceException - 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 uuid

comment - A comment for this checkin.

increment - Which increment should be increased.

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

LockException - the lock exception

DatabaseException - the database exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

liveEditCancelCheckout

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 exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

LockException - the lock exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

liveEditForceCancelCheckout

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 exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

LockException - the lock exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

AuthException

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 uuid

is - The document content in bytes.

Throws:

AutomationException - the automation exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

LockException - the lock exception

DatabaseException - the database exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

isAttachment

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 exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - 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 exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

webPageImport

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

Web page import.

Parameters:

uuid - the uuid

url - the url

Throws:

ConversionException - the conversion exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

setIndexable

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

Sets indexable.

Parameters:

uuid - the uuid

enabled - the enabled

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

LockException - the lock exception

DatabaseException - the database exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getXrefs

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 exception

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

refresh

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 exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

ParseException - the parse exception

UnknownException - the unknown exception

WebserviceException - the webservice exception