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	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.
@NotNull DocumentFile	getDocumentFile()	Returns the DocumentFile of the managed RestDocument.
@NotNull String	getDocumentId()	Returns the document ID of the managed 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.

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.