Package net.webpdf.wsclient.session.rest.documents

Interface RestDocument

All Superinterfaces:

Document

All Known Implementing Classes:

RestWebServiceDocument

public interface RestDocument
extends Document

A class implementing RestDocument represents a document, that has been uploaded to a webPDF server.

Method Summary

Modifier and Type	Method	Description
void	deleteDocument()	This is a shortcut for DocumentManager.deleteDocument(java.lang.String) and deletes the RestDocument.
void	downloadDocument(@NotNull File target)	This is a shortcut for DocumentManager.downloadDocument(RestDocument, OutputStream) and Attempts to download and write the RestDocument to the given File.
void	downloadDocument(@NotNull OutputStream target)	This is a shortcut for DocumentManager.downloadDocument(RestDocument, OutputStream) and Attempts to download and write the RestDocument to the given OutputStream.
List<? extends RestDocument>	extractDocument(@NotNull DocumentFileExtract fileExtract)	This is a shortcut for DocumentManager.extractDocument(java.lang.String, net.webpdf.wsclient.openapi.DocumentFileExtract) and extracts the RestDocument.
@NotNull DocumentFile	getDocumentFile()	Returns the DocumentFile of the managed RestDocument.
@NotNull String	getDocumentId()	Returns the document ID of the managed RestDocument.
DocumentInfo	getDocumentInfo(@NotNull DocumentInfoType infoType)	This is a shortcut for DocumentManager.renameDocument(java.lang.String, java.lang.String) and returns DocumentInfo about the RestDocument.
@NotNull List<HistoryEntry>	getHistory()	Returns the HistoryEntrys of the managed RestDocument.
@NotNull HistoryEntry	getHistoryEntry(int historyId)	Returns a HistoryEntry from the internal history map, by given history ID.
@NotNull RestDocument	renameDocument(@NotNull String fileName)	This is a shortcut for DocumentManager.renameDocument(java.lang.String, java.lang.String) and renames the RestDocument.
RestDocument	updateDocumentSecurity(@NotNull PdfPasswordType passwordType)	This is a shortcut for DocumentManager.renameDocument(java.lang.String, java.lang.String) and updates the security information the RestDocument.

Methods inherited from interface net.webpdf.wsclient.session.documents.Document

getSource, isFileSource

Method Detail

getDocumentId

@NotNull
@NotNull String getDocumentId()

Returns the document ID of the managed RestDocument.

Returns:

The document ID of the managed RestDocument.

getDocumentFile

@NotNull
@NotNull DocumentFile getDocumentFile()

Returns the DocumentFile of the managed RestDocument.

Returns:

The DocumentFile of the managed RestDocument.

getHistory

@NotNull
@NotNull List<HistoryEntry> getHistory()

Returns the HistoryEntrys of the managed RestDocument.

Returns:

The HistoryEntrys of the managed RestDocument.

getHistoryEntry

@NotNull
@NotNull HistoryEntry getHistoryEntry(int historyId)
                               throws ResultException

Returns a HistoryEntry from the internal history map, by given history ID.

Parameters:

historyId - The history ID of the HistoryEntry that shall be returned.

Returns:

A HistoryEntry representing a historic state of the uploaded resource.

Throws:

ResultException - Shall be thrown, should accessing the document history fail.

downloadDocument

void downloadDocument(@NotNull
                      @NotNull OutputStream target)
               throws ResultException

This is a shortcut for DocumentManager.downloadDocument(RestDocument, OutputStream) and Attempts to download and write the RestDocument to the given OutputStream.

Parameters:

target - The target OutputStream the RestDocument shall be written to.

Throws:

ResultException - Shall be thrown, should writing the result document fail.

downloadDocument

void downloadDocument(@NotNull
                      @NotNull File target)
               throws ResultException

This is a shortcut for DocumentManager.downloadDocument(RestDocument, OutputStream) and Attempts to download and write the RestDocument to the given File.

Parameters:

target - The target File the RestDocument shall be written to.

Throws:

ResultException - Shall be thrown, should writing the result document fail.

deleteDocument

void deleteDocument()
             throws ResultException

This is a shortcut for DocumentManager.deleteDocument(java.lang.String) and deletes the RestDocument.

Throws:

ResultException - Shall be thrown, should deleting the document fail.

renameDocument

@NotNull
@NotNull RestDocument renameDocument(@NotNull
                                     @NotNull String fileName)
                              throws ResultException

This is a shortcut for DocumentManager.renameDocument(java.lang.String, java.lang.String) and renames the RestDocument.

Parameters:

fileName - The new name for the RestDocument.

Returns:

The resulting RestDocument handle.

Throws:

ResultException - Shall be thrown, should renaming the document have failed.

updateDocumentSecurity

RestDocument updateDocumentSecurity(@NotNull
                                    @NotNull PdfPasswordType passwordType)
                             throws ResultException

This is a shortcut for DocumentManager.renameDocument(java.lang.String, java.lang.String) and updates the security information the RestDocument.

Parameters:

passwordType - The security information to update the document with

Returns:

The updated RestDocument.

Throws:

ResultException - Shall be thrown, should updating the document security have failed.

getDocumentInfo

DocumentInfo getDocumentInfo(@NotNull
                             @NotNull DocumentInfoType infoType)
                      throws ResultException

This is a shortcut for DocumentManager.renameDocument(java.lang.String, java.lang.String) and returns DocumentInfo about the RestDocument.

Parameters:

infoType - Detailed information for the document referenced by the unique documentId in the server´s document storage.

Returns:

The requested document DocumentInfo

Throws:

ResultException - Shall be thrown, should fetching the document info have failed.

extractDocument

List<? extends RestDocument> extractDocument(@NotNull
                                             @NotNull DocumentFileExtract fileExtract)
                                      throws ResultException

This is a shortcut for DocumentManager.extractDocument(java.lang.String, net.webpdf.wsclient.openapi.DocumentFileExtract) and extracts the RestDocument.

Parameters:

fileExtract - DocumentFileExtract settings for unpacking the archive document.

Returns:

A list of the extracted RestDocuments.

Throws:

ResultException - Shall be thrown, should the extraction have failed.