com.goldencode.p2j.ui.client.gui.driver.web

Interface DocumentOutputStorage

All Known Implementing Classes:

GuiWebDriver

public interface DocumentOutputStorage

The interface provides methods for storing document outputs pending to be sent to the Javascript part of FWD client. See the method javadocs in the implemented class for more information on how is the stored document output evicted in case the JS client never downloads the output.

Method Summary

Modifier and Type	Method and Description
DocumentOutput	dequeueDocumentOutput(java.util.UUID uuid) Returns the document outputs previously enqueued with enqueueDocumentOutput(DocumentOutput).
void	enqueueDocumentOutput(DocumentOutput docOutput) The method stores document outputs pending to be sent to the Javascript part of FWD client.
void	removeDocuments(java.util.Set<java.util.UUID> documents) Remove the given documents from the storage

Method Detail

enqueueDocumentOutput

void enqueueDocumentOutput(DocumentOutput docOutput)

The method stores document outputs pending to be sent to the Javascript part of FWD client.

Parameters:

docOutput - The object that encapsulates the document output being enqueued.

dequeueDocumentOutput

DocumentOutput dequeueDocumentOutput(java.util.UUID uuid)

Returns the document outputs previously enqueued with enqueueDocumentOutput(DocumentOutput). and removes the returned entry from the storage if the document outputs not cached.

Parameters:

uuid - The document output uuid.

Returns:

See above. The result may be null if the id doesn't represent a previously enqueued print output.

removeDocuments

void removeDocuments(java.util.Set<java.util.UUID> documents)

Remove the given documents from the storage

Parameters:

documents - The given documents to remove