# Uses of Class
fr.gouv.vitam.common.database.server.mongodb.VitamDocument

Packages that use VitamDocument
Package
Description
fr.gouv.vitam.common.database.server
Database server package in vitam
fr.gouv.vitam.common.database.server.elasticsearch
Elasticsearch server package in Vitam
fr.gouv.vitam.common.database.server.mongodb
MongoDB server package in Vitam
fr.gouv.vitam.functional.administration.common
Provides common classes for the Functional Administration module.
fr.gouv.vitam.functional.administration.common.schema
fr.gouv.vitam.functional.administration.common.server
Provides common server classes for the Functional Administration module
fr.gouv.vitam.logbook.common.server.database.collections
Provides Logbook collection classes
fr.gouv.vitam.metadata.core.database.collections
Provides

- ## Uses of VitamDocument in fr.gouv.vitam.common.database.server

  Methods in fr.gouv.vitam.common.database.server with type parameters of type VitamDocument
  Modifier and Type
  Method
  Description
  `<T extends VitamDocument<?>>
  List<T>`
  DbRequestResult.`getDocuments(Class<T> cls)`
  Returns directly the VitamDocuments list
  `<T extends VitamDocument<T>, V>
  List<V>`
  DbRequestResult.`getDocuments(Class<T> cls, Class<V> clsFromJson)`
  Return directly the clsFomJson items list
  `<T extends VitamDocument<T>>
  RequestResponseOK<T>`
  DbRequestResult.`getRequestResponseOK(com.fasterxml.jackson.databind.JsonNode query, Class<T> cls)`
  Return directly a RequestResponseOk from result using default VitamDocument
  `<T extends VitamDocument<T>, V>
  RequestResponseOK<V>`
  DbRequestResult.`getRequestResponseOK(com.fasterxml.jackson.databind.JsonNode query, Class<T> cls, Class<V> clsFromJson)`
  Return directly a RequestResponseOk from result using clsFromJson class
  `static <T extends VitamDocument<?>>
  com.mongodb.client.MongoCursor<T>`
  DbRequestHelper.`selectMongoDbExecuteThroughFakeMongoCursor(VitamCollection<T> collection, RequestParserSingle parser, List<String> list, List<Double> scores)`
  Private method for select using MongoDb from Elasticsearch result
  Methods in fr.gouv.vitam.common.database.server that return types with arguments of type VitamDocument
  Modifier and Type
  Method
  Description
  `com.mongodb.client.MongoCursor<VitamDocument<?>>`
  DbRequestResult.`getCursor()`
  Methods in fr.gouv.vitam.common.database.server with parameters of type VitamDocument
  Modifier and Type
  Method
  Description
  `final void`
  DbRequestResult.`filterFinalResponse(VitamDocument<?> document)`
  This method will modify the document argument in order to filter as output all _varname to corresponding #varname according to ParserTokens
  Method parameters in fr.gouv.vitam.common.database.server with type arguments of type VitamDocument
  Modifier and Type
  Method
  Description
  `void`
  DbRequestSingle.`replaceDocument(com.fasterxml.jackson.databind.JsonNode document, String identifierValue, String identifierKey, VitamCollection<VitamDocument<?>> vitamCollection)`
  `void`
  DbRequestSingle.`replaceDocuments(Map<String,com.fasterxml.jackson.databind.JsonNode> documentByIdentifiers, String identifierKey, VitamCollection<VitamDocument<?>> vitamCollection)`
  `DbRequestResult`
  DbRequestResult.`setCursor(com.mongodb.client.MongoCursor<VitamDocument<?>> cursor)`
  Constructor parameters in fr.gouv.vitam.common.database.server with type arguments of type VitamDocument
  Modifier
  Constructor
  Description
  ``
  `DbRequestSingle(VitamCollection<VitamDocument<?>> collection, OntologyLoader ontologyLoader, ElasticsearchIndexAlias elasticsearchIndexAlias)`
  Constructor with VitamCollection

- ## Uses of VitamDocument in fr.gouv.vitam.common.database.server.elasticsearch

  Methods in fr.gouv.vitam.common.database.server.elasticsearch with parameters of type VitamDocument
  Modifier and Type
  Method
  Description
  `final <T> void`
  ElasticsearchAccess.`indexEntry(ElasticsearchIndexAlias indexAlias, String id, VitamDocument<T> vitamDocument)`
  `<T> void`
  ElasticsearchAccess.`updateEntry(ElasticsearchIndexAlias indexAlias, String id, VitamDocument<T> vitamDocument)`
  Update one element fully

- ## Uses of VitamDocument in fr.gouv.vitam.common.database.server.mongodb

  Methods in fr.gouv.vitam.common.database.server.mongodb that return VitamDocument
  Modifier and Type
  Method
  Description
  `protected VitamDocument<E>`
  VitamDocument.`checkId()`
  check if Id is valid
  `abstract VitamDocument<E>`
  VitamDocument.`newInstance(com.fasterxml.jackson.databind.JsonNode content)`
  Make a new instance of the document with the given json

- ## Uses of VitamDocument in fr.gouv.vitam.functional.administration.common

  Subclasses of VitamDocument in fr.gouv.vitam.functional.administration.common
  Modifier and Type
  Class
  Description
  `class`
  `AccessContract`
  Defines an Access contract model for SIP transfer control.
  `class`
  `AccessionRegisterDetail`
  Accession Register Detail document
  `class`
  `AccessionRegisterSummary`
  Accession Register Summary document
  `class`
  `Agencies`
  Defines a Agency collection.
  `class`
  `ArchiveUnitProfile`
  Defines an archive unit Profile collection.
  `class`
  `Context`
  Defines a Context collection.
  `class`
  `FileFormat`
  FileFormat define the file referential format for Vitam
  `class`
  `FileRules`
  FileRules create the template of FileRules from VitamDocument
  `class`
  `Griffin`
  Griffin class
  `class`
  `IngestContract`
  Defines an Ingest contract model for SIP transfer control.
  `class`
  `ManagementContract`
  Defines an Management contract model
  `class`
  `Ontology`
  Defines an ontology collection.
  `class`
  `PreservationScenario`
  `class`
  `Profile`
  Defines a Profile collection.
  `class`
  `SecurityProfile`
  Defines a Security Profile collection.
  `class`
  `VitamSequence`
  Defines a Contract Sequence collection.
  Methods in fr.gouv.vitam.functional.administration.common that return VitamDocument
  Modifier and Type
  Method
  Description
  `VitamDocument<E>`
  ReferentialFile.`findDocumentById(String id)`
  find document based on a given Id
  `VitamDocument<AccessContract>`
  AccessContract.`newInstance(com.fasterxml.jackson.databind.JsonNode content)`
  `VitamDocument<AccessionRegisterDetail>`
  AccessionRegisterDetail.`newInstance(com.fasterxml.jackson.databind.JsonNode content)`
  `VitamDocument<AccessionRegisterSummary>`
  AccessionRegisterSummary.`newInstance(com.fasterxml.jackson.databind.JsonNode content)`
  `VitamDocument<Agencies>`
  Agencies.`newInstance(com.fasterxml.jackson.databind.JsonNode content)`
  `VitamDocument<ArchiveUnitProfile>`
  ArchiveUnitProfile.`newInstance(com.fasterxml.jackson.databind.JsonNode content)`
  `VitamDocument<Context>`
  Context.`newInstance(com.fasterxml.jackson.databind.JsonNode content)`
  `VitamDocument<FileFormat>`
  FileFormat.`newInstance(com.fasterxml.jackson.databind.JsonNode content)`
  `VitamDocument<FileRules>`
  FileRules.`newInstance(com.fasterxml.jackson.databind.JsonNode content)`
  `VitamDocument<Griffin>`
  Griffin.`newInstance(com.fasterxml.jackson.databind.JsonNode content)`
  `VitamDocument<IngestContract>`
  IngestContract.`newInstance(com.fasterxml.jackson.databind.JsonNode content)`
  `VitamDocument<ManagementContract>`
  ManagementContract.`newInstance(com.fasterxml.jackson.databind.JsonNode content)`
  `VitamDocument<Ontology>`
  Ontology.`newInstance(com.fasterxml.jackson.databind.JsonNode content)`
  `VitamDocument<PreservationScenario>`
  PreservationScenario.`newInstance(com.fasterxml.jackson.databind.JsonNode content)`
  `VitamDocument<Profile>`
  Profile.`newInstance(com.fasterxml.jackson.databind.JsonNode content)`
  `VitamDocument<SecurityProfile>`
  SecurityProfile.`newInstance(com.fasterxml.jackson.databind.JsonNode content)`
  `VitamDocument<VitamSequence>`
  VitamSequence.`newInstance(com.fasterxml.jackson.databind.JsonNode content)`

- ## Uses of VitamDocument in fr.gouv.vitam.functional.administration.common.schema

  Subclasses of VitamDocument in fr.gouv.vitam.functional.administration.common.schema
  Modifier and Type
  Class
  Description
  `class`
  `Schema`
  Defines a schema collection.
  Methods in fr.gouv.vitam.functional.administration.common.schema that return VitamDocument
  Modifier and Type
  Method
  Description
  `VitamDocument<Schema>`
  Schema.`newInstance(com.fasterxml.jackson.databind.JsonNode content)`

- ## Uses of VitamDocument in fr.gouv.vitam.functional.administration.common.server

  Subclasses of VitamDocument in fr.gouv.vitam.functional.administration.common.server
  Modifier and Type
  Class
  Description
  `class`
  `AccessionRegisterSymbolic`
  Accession Register Summary document
  Methods in fr.gouv.vitam.functional.administration.common.server with type parameters of type VitamDocument
  Modifier and Type
  Method
  Description
  `<T extends VitamDocument<?>>
  VitamCollection<T>`
  FunctionalAdminCollections.`getVitamCollection()`
  Methods in fr.gouv.vitam.functional.administration.common.server that return VitamDocument
  Modifier and Type
  Method
  Description
  `VitamDocument<?>`
  MongoDbAccessAdminImpl.`getDocumentById(String id, FunctionalAdminCollections collection)`
  `VitamDocument<?>`
  MongoDbAccessReferential.`getDocumentById(String id, FunctionalAdminCollections collection)`
  `VitamDocument<?>`
  MongoDbAccessAdminImpl.`getDocumentByUniqueId(String id, FunctionalAdminCollections collection, String field)`
  `VitamDocument<?>`
  MongoDbAccessReferential.`getDocumentByUniqueId(String id, FunctionalAdminCollections collection, String field)`
  `VitamDocument<AccessionRegisterSymbolic>`
  AccessionRegisterSymbolic.`newInstance(com.fasterxml.jackson.databind.JsonNode content)`

- ## Uses of VitamDocument in fr.gouv.vitam.logbook.common.server.database.collections

  Subclasses of VitamDocument in fr.gouv.vitam.logbook.common.server.database.collections
  Modifier and Type
  Class
  Description
  `class`
  `LogbookLifeCycle<T>`
  Abstract class for Logbook LifeCycle item
  `class`
  `LogbookLifeCycleObjectGroup`
  Logbook LifeCycle ObjectGroup item
  `class`
  `LogbookLifeCycleObjectGroupInProcess`
  Logbook LifeCycle ObjectGroup In Process item
  `class`
  `LogbookLifeCycleUnit`
  Logbook LifeCycle Unit item
  `class`
  `LogbookLifeCycleUnitInProcess`
  Logbook LifeCycle Unit In Process item
  `class`
  `LogbookOperation`
  Logbook Operation item
  Methods in fr.gouv.vitam.logbook.common.server.database.collections with type parameters of type VitamDocument
  Modifier and Type
  Method
  Description
  `<T extends VitamDocument<?>>
  VitamCollection<T>`
  LogbookCollections.`getVitamCollection()`
  Methods in fr.gouv.vitam.logbook.common.server.database.collections that return VitamDocument
  Modifier and Type
  Method
  Description
  `VitamDocument<LogbookLifeCycle<T>>`
  LogbookLifeCycle.`newInstance(com.fasterxml.jackson.databind.JsonNode content)`
  `VitamDocument<LogbookLifeCycle<LogbookLifeCycleObjectGroupParameters>>`
  LogbookLifeCycleObjectGroup.`newInstance(com.fasterxml.jackson.databind.JsonNode content)`
  `VitamDocument<LogbookLifeCycle<LogbookLifeCycleObjectGroupParameters>>`
  LogbookLifeCycleObjectGroupInProcess.`newInstance(com.fasterxml.jackson.databind.JsonNode content)`
  `VitamDocument<LogbookLifeCycle<LogbookLifeCycleUnitParameters>>`
  LogbookLifeCycleUnit.`newInstance(com.fasterxml.jackson.databind.JsonNode content)`
  `VitamDocument<LogbookLifeCycle<LogbookLifeCycleUnitParameters>>`
  LogbookLifeCycleUnitInProcess.`newInstance(com.fasterxml.jackson.databind.JsonNode content)`
  `VitamDocument<LogbookOperation>`
  LogbookOperation.`newInstance(com.fasterxml.jackson.databind.JsonNode content)`
  Methods in fr.gouv.vitam.logbook.common.server.database.collections that return types with arguments of type VitamDocument
  Modifier and Type
  Method
  Description
  `protected Class<? extends VitamDocument<?>>`
  LogbookCollections.`getClasz()`
  Methods in fr.gouv.vitam.logbook.common.server.database.collections with parameters of type VitamDocument
  Modifier and Type
  Method
  Description
  `<T> void`
  LogbookElasticsearchAccess.`indexEntry(LogbookCollections collection, Integer tenantId, String id, VitamDocument<T> vitamDocument)`

- ## Uses of VitamDocument in fr.gouv.vitam.metadata.core.database.collections

  Classes in fr.gouv.vitam.metadata.core.database.collections with type parameters of type VitamDocument
  Modifier and Type
  Class
  Description
  `class`
  `MongoDbMetadataRepository<T extends VitamDocument<T>>`
  Subclasses of VitamDocument in fr.gouv.vitam.metadata.core.database.collections
  Modifier and Type
  Class
  Description
  `class`
  `MetadataDocument<E>`
  The default Vitam Type object to be stored in the database (MongoDb/ElasticSearch mode)
  `class`
  `MetadataSnapshot`
  `class`
  `ObjectGroup`
  ObjectGroup:
  `class`
  `Unit`
  Unit class:
  Methods in fr.gouv.vitam.metadata.core.database.collections with parameters of type VitamDocument
  Modifier and Type
  Method
  Description
  `void`
  ElasticsearchAccessMetadata.`indexEntry(MetadataCollections collection, Integer tenantId, String id, VitamDocument<?> vitamDocument)`