com.whitestein.lsps.human

Class GenericDocumentServiceBean

java.lang.Object

com.whitestein.lsps.common.SecureAndLoggingService

com.whitestein.lsps.human.GenericDocumentServiceBean

All Implemented Interfaces:

com.whitestein.lsps.human.ejb.GenericDocumentServiceLocal, GenericDocumentServiceRemote, GenericDocumentService

@PermitAll
public class GenericDocumentServiceBean
extends com.whitestein.lsps.common.SecureAndLoggingService
implements com.whitestein.lsps.human.ejb.GenericDocumentServiceLocal, GenericDocumentServiceRemote

Stateless EJB implementation of GenericDocumentService.

Author:

mbj, bhl

Field Summary

Fields inherited from class com.whitestein.lsps.common.SecureAndLoggingService

PRINCIPAL_KEY

Constructor Summary

Constructors

Constructor and Description
GenericDocumentServiceBean()

Method Summary

Modifier and Type	Method and Description
com.whitestein.lsps.human.dto.GenericDocument	createGenericDocument(String documentId, Map<String,Object> varValues)
void	deleteDocument(long savedDocumentId)
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.
String	getImplementationType(long savedDocumentId)
String	getImplementationType(String documentId)
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.
com.whitestein.lsps.human.dto.GenericDocument	openSavedDocument(long savedDocumentId)
long	saveDocument(com.whitestein.lsps.human.dto.GenericDocument document)
long	saveDocument(com.whitestein.lsps.human.dto.GenericDocument document, boolean emptyContent)
void	saveDocument(long savedDocumentId, com.whitestein.lsps.human.dto.GenericDocument document)
void	setCompressedDocumentSavedState(long savedDocumentId, CompressedData data) Sets the saved document state.
void	setSavedDocumentState(long savedDocumentId, ByteData data) Sets the saved document state.
void	submitSavedDocument(long savedDocumentId)

Methods inherited from class com.whitestein.lsps.common.SecureAndLoggingService

getCurrentTransactionData, getOriginalPrincipal, getSecurityManagerService

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericDocumentServiceBean

public GenericDocumentServiceBean()

Method Detail

createGenericDocument

@RightsAllowed(value="Document:Read")
public com.whitestein.lsps.human.dto.GenericDocument createGenericDocument(String documentId,
                                                                                                                 Map<String,Object> varValues)
                                                                                                          throws DocumentNotFoundException

Specified by:

createGenericDocument in interface com.whitestein.lsps.human.ejb.GenericDocumentServiceLocal

Throws:

DocumentNotFoundException

getAllDocuments

@RightsAllowed(value="Document:Read")
public List<DocumentInfo> getAllDocuments()
                                                                         throws ErrorException

Description copied from interface: GenericDocumentService

Returns all generic documents.

Specified by:

getAllDocuments in interface GenericDocumentService

Returns:

all generic documents

Throws:

ErrorException

getNonParametricDocuments

public List<DocumentInfo> getNonParametricDocuments()
                                             throws ErrorException

Description copied from interface: GenericDocumentService

Returns generic documents with no parameters only.

Specified by:

getNonParametricDocuments in interface GenericDocumentService

Returns:

all generic documents

Throws:

ErrorException

getDocuments

@RightsAllowed(value="Document:Read")
public List<DocumentInfo> getDocuments(DocumentParameters parameters)
                                                                      throws ErrorException

Description copied from interface: GenericDocumentService

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.

Specified by:

getDocuments in interface GenericDocumentService

Returns:

all generic documents for parameters

Throws:

ErrorException

saveDocument

public long saveDocument(com.whitestein.lsps.human.dto.GenericDocument document)

Specified by:

saveDocument in interface com.whitestein.lsps.human.ejb.GenericDocumentServiceLocal

saveDocument

public long saveDocument(com.whitestein.lsps.human.dto.GenericDocument document,
                         boolean emptyContent)

Specified by:

saveDocument in interface com.whitestein.lsps.human.ejb.GenericDocumentServiceLocal

saveDocument

public void saveDocument(long savedDocumentId,
                         com.whitestein.lsps.human.dto.GenericDocument document)
                  throws SavedDocumentNotFoundException

Specified by:

saveDocument in interface com.whitestein.lsps.human.ejb.GenericDocumentServiceLocal

Throws:

SavedDocumentNotFoundException

deleteDocument

public void deleteDocument(long savedDocumentId)
                    throws SavedDocumentNotFoundException

Specified by:

deleteDocument in interface com.whitestein.lsps.human.ejb.GenericDocumentServiceLocal

Throws:

SavedDocumentNotFoundException

getSavedDocuments

@RightsAllowed(value="Document:Read")
public SavedDocumentList getSavedDocuments(SavedDocumentCriteria criteria)

Description copied from interface: GenericDocumentService

Returns all saved documents according to criteria.

Specified by:

getSavedDocuments in interface GenericDocumentService

Returns:

all saved documents according to criteria

getSavedDocument

@RightsAllowed(value="Document:Read")
public SavedDocument getSavedDocument(long savedDocumentId,
                                                                            boolean includeContent)
                                                                     throws SavedDocumentNotFoundException

Description copied from interface: GenericDocumentService

Returns the saved document. The content is optionally included.

Specified by:

getSavedDocument in interface GenericDocumentService

Returns:

the saved document object

Throws:

SavedDocumentNotFoundException

openSavedDocument

@RightsAllowed(value="Document:Read")
public com.whitestein.lsps.human.dto.GenericDocument openSavedDocument(long savedDocumentId)
                                                                                                      throws SavedDocumentNotFoundException

Specified by:

openSavedDocument in interface com.whitestein.lsps.human.ejb.GenericDocumentServiceLocal

Throws:

SavedDocumentNotFoundException

submitSavedDocument

public void submitSavedDocument(long savedDocumentId)
                         throws LspsException

Specified by:

submitSavedDocument in interface com.whitestein.lsps.human.ejb.GenericDocumentServiceLocal

Throws:

LspsException

getImplementationType

public String getImplementationType(String documentId)
                             throws DocumentNotFoundException

Specified by:

getImplementationType in interface com.whitestein.lsps.human.ejb.GenericDocumentServiceLocal

Throws:

DocumentNotFoundException

getImplementationType

public String getImplementationType(long savedDocumentId)
                             throws DocumentNotFoundException

Specified by:

getImplementationType in interface com.whitestein.lsps.human.ejb.GenericDocumentServiceLocal

Throws:

DocumentNotFoundException

getSavedDocumentState

@RightsAllowed(value="Document:Read")
public ByteData getSavedDocumentState(long savedDocumentId)
                                                                     throws SavedDocumentNotFoundException

Description copied from interface: GenericDocumentService

Returns the content of a saved document.

Specified by:

getSavedDocumentState in interface GenericDocumentService

Returns:

the content data

Throws:

SavedDocumentNotFoundException

getCompressedSavedDocumentState

@RightsAllowed(value="Document:Read")
public CompressedData getCompressedSavedDocumentState(long savedDocumentId)
                                                                                     throws SavedDocumentNotFoundException

Description copied from interface: GenericDocumentService

Returns the content of a saved document.

Specified by:

getCompressedSavedDocumentState in interface GenericDocumentService

Returns:

the content data

Throws:

SavedDocumentNotFoundException

setSavedDocumentState

@RightsAllowed(value="Document:Write")
public void setSavedDocumentState(long savedDocumentId,
                                                                         ByteData data)
                                                                  throws SavedDocumentNotFoundException

Description copied from interface: GenericDocumentService

Sets the saved document state.

Specified by:

setSavedDocumentState in interface GenericDocumentService

Throws:

SavedDocumentNotFoundException

setCompressedDocumentSavedState

@RightsAllowed(value="Document:Write")
public void setCompressedDocumentSavedState(long savedDocumentId,
                                                                                   CompressedData data)
                                                                            throws SavedDocumentNotFoundException

Description copied from interface: GenericDocumentService

Sets the saved document state.

Specified by:

setCompressedDocumentSavedState in interface GenericDocumentService

Throws:

SavedDocumentNotFoundException