net.webpdf.wsclient.documents

Class RestDocument

java.lang.Object

net.webpdf.wsclient.documents.RestDocument

All Implemented Interfaces:

Document

public class RestDocument
extends Object

Constructor Summary

Constructors

Constructor and Description
RestDocument(@Nullable String documentId) Manages a REST document with the given document ID.

Method Summary

Modifier and Type	Method and Description
@NotNull HistoryEntry	activeHistory() Gets the active HistoryEntry
@NotNull HistoryEntry	findHistory(int historyId) Finds a HistoryEntry by it's history id
@Nullable DocumentFileBean	getDocumentFile() Returns the DocumentFileBean of the managed REST document.
@NotNull List<HistoryEntry>	getHistory() Returns a copied List<HistoryEntry> of the managed REST document.
int	getHistorySize() Returns the size of the history entries list
@Nullable URI	getSource() Returns the URI of the document source.
@Nullable String	getSourceDocumentId() Returns the document ID of the managed REST document.
boolean	isFileSource() Returns true if the URI of the document source points to a file.
@NotNull HistoryEntry	lastHistory() Gets the last HistoryEntry from the internal map of history entries
void	setDocumentFile(@Nullable DocumentFileBean documentFile) sets the DocumentFileBean of the managed REST document.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestDocument

public RestDocument(@Nullable
                    @Nullable String documentId)

Manages a REST document with the given document ID.

Parameters:

documentId - The document ID of the managed REST document.

Method Detail

getSourceDocumentId

@Nullable
public @Nullable String getSourceDocumentId()

Returns the document ID of the managed REST document.

Returns:

The document ID of the managed REST document.

getDocumentFile

@Nullable
public @Nullable DocumentFileBean getDocumentFile()

Returns the DocumentFileBean of the managed REST document.

Returns:

The DocumentFileBean of the managed REST document.

setDocumentFile

public void setDocumentFile(@Nullable
                            @Nullable DocumentFileBean documentFile)

sets the DocumentFileBean of the managed REST document.

Parameters:

documentFile - the new DocumentFileBean of the managed REST document.

getHistory

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

Returns a copied List<HistoryEntry> of the managed REST document.

Returns:

the List<HistoryEntry> of the managed REST document.

lastHistory

@NotNull
public @NotNull HistoryEntry lastHistory()
                                            throws ResultException

Gets the last HistoryEntry from the internal map of history entries

Returns:

last HistoryEntry in list

Throws:

ResultException - history entry list is empty

activeHistory

@NotNull
public @NotNull HistoryEntry activeHistory()
                                              throws ResultException

Gets the active HistoryEntry

Returns:

active HistoryEntry

Throws:

ResultException - no active history entry

findHistory

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

Finds a HistoryEntry by it's history id

Parameters:

historyId - unique history id

Returns:

found HistoryEntry

Throws:

ResultException - unable to find history id

getHistorySize

public int getHistorySize()

Returns the size of the history entries list

Returns:

number of history entries

getSource

@Nullable
public @Nullable URI getSource()

Returns the URI of the document source.

Specified by:

getSource in interface Document

Returns:

The URI of the document source.

isFileSource

public boolean isFileSource()

Returns true if the URI of the document source points to a file.

Returns:

True if the URI of the document source points to a file.