Package com.openkm.sdk4j.definition

Interface BasePdf

All Known Implementing Classes:

PdfImpl

public interface BasePdf

BasePdf

Author:

sochoa

Method Summary

Modifier and Type	Method	Description
Document	extract(String uuid, String dstId, String name, List<Integer> pages)	Extract pages from a document.
InputStream	getImage(String uuid, int page, String size)	Gets image.
Document	insertPages(String uuid, InsertPagesRequest request)	Insert pages boolean.
boolean	optimize(String uuid)
Document	remove(String uuid, String dstId, String name, List<Integer> pages)	Remove pages of a document
Document	rotate(String uuid, String dstId, String name, Integer angle, List<Integer> pages)	Rotate pages of a document.
List<Document>	split(String uuid, String dstId, String baseName, List<Integer> pages)	Split document.

Method Detail

getImage

InputStream getImage(String uuid,
                     int page,
                     String size)
              throws RepositoryException,
                     AccessDeniedException,
                     PathNotFoundException,
                     DatabaseException,
                     ConversionException,
                     WebserviceException,
                     UnknownException

Gets image.

Parameters:

uuid - the uuid

page - the page

size - the size

Returns:

the image

Throws:

RepositoryException - the repository exception

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

ConversionException - the conversion exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

split

List<Document> split(String uuid,
                     String dstId,
                     String baseName,
                     List<Integer> pages)
              throws DatabaseException,
                     RepositoryException,
                     AccessDeniedException,
                     PathNotFoundException,
                     DocumentException,
                     AutomationException,
                     UnsupportedMimeTypeException,
                     AuthException,
                     ItemExistsException,
                     VirusDetectedException,
                     UnknownException,
                     WebserviceException

Split document.

Parameters:

uuid - the uuid

dstId - the dst id

baseName - the base name

pages - the pages

Returns:

the documents created

Throws:

DatabaseException - the database exception

RepositoryException - the repository exception

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

DocumentException - the document exception

AutomationException - the automation exception

UnsupportedMimeTypeException - the unsupported mime type exception

AuthException - the principal adapter exception

ItemExistsException - the item exists exception

VirusDetectedException - the virus detected exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

extract

Document extract(String uuid,
                 String dstId,
                 String name,
                 List<Integer> pages)
          throws DatabaseException,
                 RepositoryException,
                 AccessDeniedException,
                 PathNotFoundException,
                 DocumentException,
                 AutomationException,
                 UnsupportedMimeTypeException,
                 AuthException,
                 ItemExistsException,
                 VirusDetectedException,
                 UnknownException,
                 WebserviceException

Extract pages from a document.

Parameters:

uuid - the uuid

dstId - the dst id

name - the name

pages - the pages

Returns:

the new document created

Throws:

DatabaseException - the database exception

RepositoryException - the repository exception

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

DocumentException - the document exception

AutomationException - the automation exception

UnsupportedMimeTypeException - the unsupported mime type exception

AuthException - the principal adapter exception

ItemExistsException - the item exists exception

VirusDetectedException - the virus detected exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

remove

Document remove(String uuid,
                String dstId,
                String name,
                List<Integer> pages)
         throws DatabaseException,
                RepositoryException,
                AccessDeniedException,
                PathNotFoundException,
                DocumentException,
                AutomationException,
                UnsupportedMimeTypeException,
                AuthException,
                ItemExistsException,
                VirusDetectedException,
                UnknownException,
                WebserviceException

Remove pages of a document

Parameters:

uuid - the uuid

dstId - the dst id

name - the name

pages - the pages

Returns:

the document updated

Throws:

DatabaseException - the database exception

IOException - the io exception

RepositoryException - the repository exception

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

DocumentException - the document exception

AutomationException - the automation exception

UnsupportedMimeTypeException - the unsupported mime type exception

AuthException - the principal adapter exception

ItemExistsException - the item exists exception

VirusDetectedException - the virus detected exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

rotate

Document rotate(String uuid,
                String dstId,
                String name,
                Integer angle,
                List<Integer> pages)
         throws DatabaseException,
                RepositoryException,
                AccessDeniedException,
                PathNotFoundException,
                DocumentException,
                AutomationException,
                UnsupportedMimeTypeException,
                AuthException,
                ItemExistsException,
                VirusDetectedException,
                UnknownException,
                WebserviceException

Rotate pages of a document.

Parameters:

uuid - the uuid

dstId - the dst id

name - the name

angle - the angle

pages - the pages

Returns:

the document with pages rotated

Throws:

DatabaseException - the database exception

RepositoryException - the repository exception

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

DocumentException - the document exception

AutomationException - the automation exception

UnsupportedMimeTypeException - the unsupported mime type exception

AuthException - the principal adapter exception

ItemExistsException - the item exists exception

VirusDetectedException - the virus detected exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

insertPages

Document insertPages(String uuid,
                     InsertPagesRequest request)
              throws DatabaseException,
                     RepositoryException,
                     AccessDeniedException,
                     PathNotFoundException,
                     DocumentException,
                     AutomationException,
                     UnsupportedMimeTypeException,
                     AuthException,
                     ItemExistsException,
                     VirusDetectedException,
                     UnknownException,
                     WebserviceException

Insert pages boolean.

Parameters:

uuid - the uuid

Returns:

the boolean

Throws:

DatabaseException - the database exception

RepositoryException - the repository exception

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

DocumentException - the document exception

AutomationException - the automation exception

UnsupportedMimeTypeException - the unsupported mime type exception

AuthException - the principal adapter exception

ItemExistsException - the item exists exception

VirusDetectedException - the virus detected exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

optimize

boolean optimize(String uuid)
          throws DatabaseException,
                 RepositoryException,
                 AccessDeniedException,
                 PathNotFoundException,
                 DocumentException,
                 AutomationException,
                 UnsupportedMimeTypeException,
                 AuthException,
                 ItemExistsException,
                 VirusDetectedException,
                 UnknownException,
                 WebserviceException

Throws:

DatabaseException

RepositoryException

AccessDeniedException

PathNotFoundException

DocumentException

AutomationException

UnsupportedMimeTypeException

AuthException

ItemExistsException

VirusDetectedException

UnknownException

WebserviceException