org.openfact.models

Interface DocumentProvider

public interface DocumentProvider

Method Summary

Modifier and Type	Method and Description
DocumentModel	addDocument(DocumentType documentType, String documentId, OrganizationModel organization)
DocumentModel	addDocument(String documentType, String documentId, OrganizationModel organization)
DocumentQuery	createQuery(OrganizationModel organization)
DocumentModel	getDocumentById(String id, OrganizationModel organization)
DocumentModel	getDocumentByTypeAndDocumentId(DocumentType documentType, String documentId, OrganizationModel organization)
DocumentModel	getDocumentByTypeAndDocumentId(String documentType, String documentId, OrganizationModel organization)
List<DocumentModel>	getDocuments(OrganizationModel organization)
List<DocumentModel>	getDocuments(OrganizationModel organization, int firstResult, int maxResults)
int	getDocumentsCount(OrganizationModel organization)
void	preRemove(OrganizationModel organization)
boolean	removeDocument(String id, OrganizationModel organization)
List<DocumentModel>	searchForDocument(String filterText, OrganizationModel organization)
List<DocumentModel>	searchForDocument(String filterText, OrganizationModel organization, int firstResult, int maxResults)

Method Detail

createQuery

DocumentQuery createQuery(OrganizationModel organization)

addDocument

DocumentModel addDocument(String documentType,
                          String documentId,
                          OrganizationModel organization)
                   throws ModelException

Throws:

ModelException

addDocument

DocumentModel addDocument(DocumentType documentType,
                          String documentId,
                          OrganizationModel organization)
                   throws ModelException

Throws:

ModelException

getDocumentById

DocumentModel getDocumentById(String id,
                              OrganizationModel organization)

Parameters:

id -

organization -

Returns:

getDocumentByTypeAndDocumentId

DocumentModel getDocumentByTypeAndDocumentId(String documentType,
                                             String documentId,
                                             OrganizationModel organization)

Parameters:

documentType -

documentId -

organization -

Returns:

getDocumentByTypeAndDocumentId

DocumentModel getDocumentByTypeAndDocumentId(DocumentType documentType,
                                             String documentId,
                                             OrganizationModel organization)

preRemove

void preRemove(OrganizationModel organization)

Parameters:

organization -

removeDocument

boolean removeDocument(String id,
                       OrganizationModel organization)

getDocumentsCount

int getDocumentsCount(OrganizationModel organization)

Parameters:

organization -

getDocuments

List<DocumentModel> getDocuments(OrganizationModel organization)

Parameters:

organization -

getDocuments

List<DocumentModel> getDocuments(OrganizationModel organization,
                                 int firstResult,
                                 int maxResults)

searchForDocument

List<DocumentModel> searchForDocument(String filterText,
                                      OrganizationModel organization)

searchForDocument

List<DocumentModel> searchForDocument(String filterText,
                                      OrganizationModel organization,
                                      int firstResult,
                                      int maxResults)