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

Class RestWebServiceDocument

java.lang.Object

net.webpdf.wsclient.session.documents.AbstractDocument

net.webpdf.wsclient.session.rest.documents.RestWebServiceDocument

All Implemented Interfaces:

Document, RestDocument

public class RestWebServiceDocument
extends AbstractDocument
implements RestDocument

An instance of RestWebServiceDocument 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 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 class net.webpdf.wsclient.session.documents.AbstractDocument

getSource, isFileSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getSource, isFileSource

Method Detail

getDocumentId

@NotNull
public @NotNull String getDocumentId()

Returns the document ID of the managed RestDocument.

Specified by:

getDocumentId in interface RestDocument

Returns:

The document ID of the managed RestDocument.

getDocumentFile

@NotNull
public @NotNull DocumentFile getDocumentFile()

Returns the DocumentFile of the managed RestDocument.

Specified by:

getDocumentFile in interface RestDocument

Returns:

The DocumentFile of the managed RestDocument.

getHistory

@NotNull
public @NotNull List<HistoryEntry> getHistory()

Returns the HistoryEntrys of the managed RestDocument.

Specified by:

getHistory in interface RestDocument

Returns:

The HistoryEntrys of the managed RestDocument.

getHistoryEntry

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

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

Specified by:

getHistoryEntry in interface RestDocument

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

public 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.

Specified by:

downloadDocument in interface RestDocument

Parameters:

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

Throws:

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

downloadDocument

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

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

Specified by:

downloadDocument in interface RestDocument

Parameters:

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

Throws:

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