com.whitestein.lsps.human

Interface DocumentDefinitionService

All Known Implementing Classes:

DocumentDefinitionServiceBean

public interface DocumentDefinitionService

Provides API for resolving document definitions.

Author:

bhl

Method Summary

Modifier and Type	Method and Description
java.util.List<Document>	getAllGenericDocuments() Returns list of all latest documents of type "GENERIC".
DocumentDefinition	getDocumentDefinition(java.lang.String documentId) Returns latest DocumentDefinition for the provided QID
DocumentDefinition	getDocumentDefinition(java.lang.String documentName, Module module) Returns DocumentDefinition with the specified name defined in a module.
Module	getDocumentModule(java.lang.String documentId) Returns latest module in which the document is defined.

Method Detail

getDocumentDefinition

DocumentDefinition getDocumentDefinition(java.lang.String documentId)
                                  throws DocumentNotFoundException

Returns latest DocumentDefinition for the provided QID

Parameters:

documentId -

Returns:

a document definition

Throws:

DocumentNotFoundException

getDocumentDefinition

DocumentDefinition getDocumentDefinition(java.lang.String documentName,
                                         Module module)
                                  throws DocumentNotFoundException

Returns DocumentDefinition with the specified name defined in a module.

Parameters:

module -

documentName -

Returns:

a document definition

Throws:

DocumentNotFoundException

getDocumentModule

Module getDocumentModule(java.lang.String documentId)
                  throws DocumentNotFoundException

Returns latest module in which the document is defined.

Parameters:

documentId -

Returns:

module

Throws:

DocumentNotFoundException

getAllGenericDocuments

java.util.List<Document> getAllGenericDocuments()

Returns list of all latest documents of type "GENERIC".

Returns:

list of all latest documents of type "GENERIC"