com.whitestein.lsps.human

Interface GenericDocumentService

All Known Subinterfaces:

GenericDocumentServiceRemote

All Known Implementing Classes:

GenericDocumentServiceBean

public interface GenericDocumentService

Service for new generation of renderers. Provides means to access generic documents descriptors, which can be later utilized in the web layer within a transaction scope.

Author:

mbj

Method Summary

Modifier and Type	Method and Description
List<DocumentInfo>	getAllDocuments() Returns all generic documents.
CompressedData	getCompressedSavedDocumentState(long savedDocumentId) Returns the content of a saved document.
List<DocumentInfo>	getDocuments(DocumentParameters parameters) Returns all generic documents for the parameters.
List<DocumentInfo>	getNonParametricDocuments() Returns generic documents with no parameters only.
SavedDocument	getSavedDocument(long savedDocumentId, boolean includeContent) Returns the saved document.
SavedDocumentList	getSavedDocuments(SavedDocumentCriteria criteria) Returns all saved documents according to criteria.
ByteData	getSavedDocumentState(long savedDocumentId) Returns the content of a saved document.
void	setCompressedDocumentSavedState(long savedDocumentId, CompressedData data) Sets the saved document state.
void	setSavedDocumentState(long savedDocumentId, ByteData data) Sets the saved document state.

Method Detail

getAllDocuments

List<DocumentInfo> getAllDocuments()
                            throws ErrorException

Returns all generic documents.

Returns:

all generic documents

Throws:

ErrorException

getNonParametricDocuments

List<DocumentInfo> getNonParametricDocuments()
                                      throws ErrorException

Returns generic documents with no parameters only.

Returns:

all generic documents

Throws:

ErrorException

getDocuments

List<DocumentInfo> getDocuments(DocumentParameters parameters)
                         throws ErrorException

Returns all generic documents for the parameters. The parameters are used for evaluation access expression. If the evaluation of the expression returns true the document is included in the result.

Parameters:

parameters -

Returns:

all generic documents for parameters

Throws:

ErrorException

getSavedDocuments

SavedDocumentList getSavedDocuments(SavedDocumentCriteria criteria)

Returns all saved documents according to criteria.

Parameters:

criteria -

Returns:

all saved documents according to criteria

getSavedDocument

SavedDocument getSavedDocument(long savedDocumentId,
                               boolean includeContent)
                        throws SavedDocumentNotFoundException

Returns the saved document. The content is optionally included.

Parameters:

savedDocumentId -

includeContent -

Returns:

the saved document object

Throws:

SavedDocumentNotFoundException

getSavedDocumentState

ByteData getSavedDocumentState(long savedDocumentId)
                        throws SavedDocumentNotFoundException

Returns the content of a saved document.

Parameters:

savedDocumentId -

Returns:

the content data

Throws:

SavedDocumentNotFoundException

getCompressedSavedDocumentState

CompressedData getCompressedSavedDocumentState(long savedDocumentId)
                                        throws SavedDocumentNotFoundException

Returns the content of a saved document.

Parameters:

savedDocumentId -

Returns:

the content data

Throws:

SavedDocumentNotFoundException

setSavedDocumentState

void setSavedDocumentState(long savedDocumentId,
                           ByteData data)
                    throws SavedDocumentNotFoundException

Sets the saved document state.

Parameters:

savedDocumentId -

data -

Throws:

SavedDocumentNotFoundException

setCompressedDocumentSavedState

void setCompressedDocumentSavedState(long savedDocumentId,
                                     CompressedData data)
                              throws SavedDocumentNotFoundException

Sets the saved document state.

Parameters:

savedDocumentId -

data -

Throws:

SavedDocumentNotFoundException