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

Class RestWebServiceDocumentState

java.lang.Object

net.webpdf.wsclient.session.rest.documents.RestWebServiceDocumentState

All Implemented Interfaces:

RestDocumentState<RestWebServiceDocument>

public class RestWebServiceDocumentState
extends Object
implements RestDocumentState<RestWebServiceDocument>

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

The RestWebServiceDocumentState allows a RestWebServiceDocument 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.)

Constructor Summary

Constructors

Constructor	Description
RestWebServiceDocumentState(@NotNull String documentId, @NotNull RestWebServiceDocumentManager documentManager)	Creates a RestWebServiceDocumentState known to the webPDF server by the given document ID.

Method Summary

Modifier and Type	Method	Description
@NotNull HistoryEntry	activeHistory()	Returns the currently active HistoryEntry.
@NotNull DocumentFile	getDocumentFile()	Returns the DocumentFile of the managed RestWebServiceDocument.
@NotNull String	getDocumentId()	Returns the document ID of the managed RestWebServiceDocument.
@NotNull DocumentManager<RestWebServiceDocument>	getDocumentManager()	Returns the owning DocumentManager.
@NotNull List<HistoryEntry>	getHistory()	Returns the HistoryEntrys of the managed RestWebServiceDocument.
@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 RestWebServiceDocument.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestWebServiceDocumentState

public RestWebServiceDocumentState(@NotNull
                                   @NotNull String documentId,
                                   @NotNull
                                   @NotNull RestWebServiceDocumentManager documentManager)

Creates a RestWebServiceDocumentState known to the webPDF server by the given document ID.

Parameters:

documentId - The document ID of the managed RestWebServiceDocument.

documentManager - The owning DocumentManager

Method Detail

getDocumentId

@NotNull
public @NotNull String getDocumentId()

Returns the document ID of the managed RestWebServiceDocument.

Specified by:

getDocumentId in interface RestDocumentState<RestWebServiceDocument>

Returns:

The document ID of the managed RestWebServiceDocument.

getDocumentFile

@NotNull
public @NotNull DocumentFile getDocumentFile()

Returns the DocumentFile of the managed RestWebServiceDocument.

Specified by:

getDocumentFile in interface RestDocumentState<RestWebServiceDocument>

Returns:

The DocumentFile of the managed RestWebServiceDocument.

setDocumentFile

public void setDocumentFile(@NotNull
                            @NotNull DocumentFile documentFile)

Sets the DocumentFile of the managed RestWebServiceDocument.

Specified by:

setDocumentFile in interface RestDocumentState<RestWebServiceDocument>

Parameters:

documentFile - the new DocumentFile of the managed RestWebServiceDocument.

getHistory

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

Returns the HistoryEntrys of the managed RestWebServiceDocument.

Specified by:

getHistory in interface RestDocumentState<RestWebServiceDocument>

Returns:

The HistoryEntrys of the managed RestWebServiceDocument.

setHistory

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

Replaces the internally stored HistoryEntry list of the managed RestDocument

Specified by:

setHistory in interface RestDocumentState<RestWebServiceDocument>

Parameters:

historyEntries - The new HistoryEntrys to be set.

Throws:

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

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 RestDocumentState<RestWebServiceDocument>

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

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

Updates the given HistoryEntry in the internally managed document history.

Specified by:

updateHistoryEntry in interface RestDocumentState<RestWebServiceDocument>

Parameters:

historyEntry - The HistoryEntry containing the values to be set.

Throws:

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

lastHistory

@NotNull
public @NotNull HistoryEntry lastHistory()
                                  throws ResultException

Returns the most recent HistoryEntry.

Specified by:

lastHistory in interface RestDocumentState<RestWebServiceDocument>

Returns:

The most recent HistoryEntry.

Throws:

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

getHistorySize

public int getHistorySize()

Returns the number of known HistoryEntrys for this RestWebServiceDocument.

Specified by:

getHistorySize in interface RestDocumentState<RestWebServiceDocument>

Returns:

The number of known HistoryEntrys for this RestWebServiceDocument.

activeHistory

@NotNull
public @NotNull HistoryEntry activeHistory()
                                    throws ResultException

Returns the currently active HistoryEntry.

Specified by:

activeHistory in interface RestDocumentState<RestWebServiceDocument>

Returns:

The currently active HistoryEntry.

Throws:

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

getDocumentManager

@NotNull
public @NotNull DocumentManager<RestWebServiceDocument> getDocumentManager()

Returns the owning DocumentManager.

Specified by:

getDocumentManager in interface RestDocumentState<RestWebServiceDocument>

Returns:

The owning DocumentManager.