Package fr.gouv.vitam.functional.administration.common

Interface ReferentialFile<E>

Type Parameters:

E - Type of Referential

All Known Implementing Classes:

ReferentialFormatFileImpl, RulesManagerFileImpl

public interface ReferentialFile<E>

ReferentialFile

Method Summary

Modifier and Type	Method	Description
VitamDocument<E>	findDocumentById(String id)	find document based on a given Id
RequestResponseOK<E>	findDocuments(com.fasterxml.jackson.databind.JsonNode select)	find document based on DSL query
void	importFile(InputStream file, String filename)	importFile : import reference file to database

Method Details

importFile

void importFile(InputStream file,
 String filename)
         throws VitamException,
IOException,
InvalidCreateOperationException,
IllegalPathException

importFile : import reference file to database

Parameters:

file - as InputStream

filename - file name

Throws:

ReferentialException - when there is error of import

DatabaseConflictException - when there is a database conflict

IOException

InvalidParseOperationException

InvalidCreateOperationException

VitamException

IllegalPathException

findDocumentById

VitamDocument<E> findDocumentById(String id)
                           throws ReferentialException

find document based on a given Id

Parameters:

id - of vitam document

Returns:

vitam document

Throws:

ReferentialException - when error occurs

findDocuments

RequestResponseOK<E> findDocuments(com.fasterxml.jackson.databind.JsonNode select)
                            throws FileFormatNotFoundException,
ReferentialException

find document based on DSL query

Parameters:

select - filter

Returns:

vitam document list

Throws:

FileFormatNotFoundException - when no results found

ReferentialException - when error occurs