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

Interface RestDocumentState<T_DOCUMENT extends RestDocument>

All Known Implementing Classes:

RestWebServiceDocumentState

public interface RestDocumentState<T_DOCUMENT extends RestDocument>

An instance of RestDocumentState represents the internal state of a RestDocument, that has been uploaded to a webPDF server.

The RestDocumentState allows a RestDocument to access and publish the state, without violating the exclusive update rights of the DocumentManager.
(i.e. The DocumentManager shall always be the only entity, that is allowed to change the internal state of an uploaded document.)

Method Summary

Modifier and Type	Method	Description
@NotNull HistoryEntry	activeHistory()	Returns the currently active HistoryEntry.
@NotNull DocumentFile	getDocumentFile()	Returns the DocumentFile of the managed RestDocument.
@NotNull String	getDocumentId()	Returns the document ID of the managed RestDocument.
@NotNull DocumentManager<T_DOCUMENT>	getDocumentManager()	Returns the owning DocumentManager.
@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.
int	getHistorySize()	Returns the number of known HistoryEntrys for this RestWebServiceDocument.
@NotNull HistoryEntry	lastHistory()	Returns the most recent HistoryEntry.
void	setDocumentFile(@NotNull DocumentFile documentFile)	Sets the DocumentFile of the managed RestDocument.
void	setHistory(@NotNull HistoryEntry[] historyEntries)	Replaces the internally stored HistoryEntry list of the managed RestDocument
void	updateHistoryEntry(@NotNull HistoryEntry historyEntry)	Updates the given HistoryEntry in the internally managed document history.

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.

setDocumentFile

void setDocumentFile(@NotNull
                     @NotNull DocumentFile documentFile)

Sets the DocumentFile of the managed RestDocument.

Parameters:

documentFile - the new 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.

setHistory

void setHistory(@NotNull
                @NotNull HistoryEntry[] historyEntries)
         throws ResultException

Replaces the internally stored HistoryEntry list of the managed RestDocument

Parameters:

historyEntries - The new HistoryEntrys to be set.

Throws:

ResultException - Shall be thrown, when updating the document history failed.

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.

updateHistoryEntry

void updateHistoryEntry(@NotNull
                        @NotNull HistoryEntry historyEntry)
                 throws ResultException

Updates the given HistoryEntry in the internally managed document history.

Parameters:

historyEntry - The HistoryEntry containing the values to be set.

Throws:

ResultException - Shall be thrown, when updating the document history failed.

lastHistory

@NotNull
@NotNull HistoryEntry lastHistory()
                           throws ResultException

Returns the most recent HistoryEntry.

Returns:

The most recent HistoryEntry.

Throws:

ResultException - Shall be thrown, when updating the document history failed.

getHistorySize

int getHistorySize()

Returns the number of known HistoryEntrys for this RestWebServiceDocument.

Returns:

The number of known HistoryEntrys for this RestWebServiceDocument.

activeHistory

@NotNull
@NotNull HistoryEntry activeHistory()
                             throws ResultException

Returns the currently active HistoryEntry.

Returns:

The currently active HistoryEntry.

Throws:

ResultException - Shall be thrown, when updating the document history failed.

getDocumentManager

@NotNull
@NotNull DocumentManager<T_DOCUMENT> getDocumentManager()

Returns the owning DocumentManager.

Returns:

The owning DocumentManager.