# Uses of Class
fr.gouv.vitam.functional.administration.common.exception.ReferentialException

Packages that use ReferentialException
Package
Description
fr.gouv.vitam.functional.administration.client
Provides Functional administration client interface, factory and implementations.
fr.gouv.vitam.functional.administration.common
Provides common classes for the Functional Administration module.
fr.gouv.vitam.functional.administration.common.counter
fr.gouv.vitam.functional.administration.common.exception
Provides Exception classes for the Functional Administration module.
fr.gouv.vitam.functional.administration.common.server
Provides common server classes for the Functional Administration module
fr.gouv.vitam.functional.administration.core.accession.register
fr.gouv.vitam.functional.administration.core.agencies
fr.gouv.vitam.functional.administration.core.archiveunitprofiles
fr.gouv.vitam.functional.administration.core.archiveunitprofilesSchema
fr.gouv.vitam.functional.administration.core.context
fr.gouv.vitam.functional.administration.core.contract
fr.gouv.vitam.functional.administration.core.format
fr.gouv.vitam.functional.administration.core.griffin
fr.gouv.vitam.functional.administration.core.ontologies
fr.gouv.vitam.functional.administration.core.profile
fr.gouv.vitam.functional.administration.core.rules
fr.gouv.vitam.functional.administration.core.schema
fr.gouv.vitam.functional.administration.core.security.profile

- ## Uses of ReferentialException in fr.gouv.vitam.functional.administration.client

  Methods in fr.gouv.vitam.functional.administration.client that throw ReferentialException
  Modifier and Type
  Method
  Description
  `jakarta.ws.rs.core.Response`
  AdminManagementClient.`checkAgenciesFile(InputStream stream)`
  Check if agencies file is well formated
  `jakarta.ws.rs.core.Response`
  AdminManagementClient.`checkFormat(InputStream stream)`
  `RequestResponse<AccessionRegisterSummaryModel>`
  AdminManagementClient.`getAccessionRegister(com.fasterxml.jackson.databind.JsonNode query)`
  Get the accession register summary matching the given query
  `RequestResponse<AccessionRegisterDetailModel>`
  AdminManagementClient.`getAccessionRegisterDetail(com.fasterxml.jackson.databind.JsonNode query)`
  Get the accession register details matching the given query
  `RequestResponse<AccessionRegisterDetailModel>`
  AdminManagementClient.`getAccessionRegisterDetail(String originatingAgency, com.fasterxml.jackson.databind.JsonNode query)`
  Get the accession register details matching the given query for the specified contract
  `com.fasterxml.jackson.databind.JsonNode`
  AdminManagementClient.`getAgencies(com.fasterxml.jackson.databind.JsonNode query)`
  List the agencies that match the query
  `com.fasterxml.jackson.databind.JsonNode`
  AdminManagementClient.`getFormatByID(String id)`
  `RequestResponse<FileFormatModel>`
  AdminManagementClient.`getFormats(com.fasterxml.jackson.databind.JsonNode query)`
  `jakarta.ws.rs.core.Response.Status`
  AdminManagementClient.`importAgenciesFile(InputStream stream, String filename)`
  Import agencies for a given tenant
  `jakarta.ws.rs.core.Response.Status`
  AdminManagementClientMock.`importAgenciesFile(InputStream stream, String filename)`
  `jakarta.ws.rs.core.Response.Status`
  AdminManagementClient.`importContexts(List<ContextModel> contextModelList)`
  Import a set of context
  `jakarta.ws.rs.core.Response.Status`
  AdminManagementClientMock.`importContexts(List<ContextModel> contextModelList)`
  `jakarta.ws.rs.core.Response.Status`
  AdminManagementClient.`importFormat(InputStream stream, String filename)`
  `RequestResponse<ProfileModel>`
  AdminManagementClient.`importProfileFile(String profileMetadataId, InputStream stream)`
  `RequestResponse`
  AdminManagementClientMock.`importProfileFile(String profileMetadataId, InputStream stream)`
  `jakarta.ws.rs.core.Response.Status`
  AdminManagementClient.`importRulesFile(InputStream stream, String filename)`
  Import a the set of rules for a given tenant
  `jakarta.ws.rs.core.Response.Status`
  AdminManagementClientMock.`importRulesFile(InputStream stream, String filename)`

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

  Methods in fr.gouv.vitam.functional.administration.common that throw ReferentialException
  Modifier and Type
  Method
  Description
  `VitamDocument<E>`
  ReferentialFile.`findDocumentById(String id)`
  find document based on a given Id
  `RequestResponseOK<E>`
  ReferentialFile.`findDocuments(com.fasterxml.jackson.databind.JsonNode select)`
  find document based on DSL query

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

  Methods in fr.gouv.vitam.functional.administration.common.counter that throw ReferentialException
  Modifier and Type
  Method
  Description
  `VitamSequence`
  VitamCounterService.`getNextBackupSequenceDocument(Integer tenant, SequenceType sequenceType)`
  Atomically find a backup sequence and update it, returning updated document.
  `Integer`
  VitamCounterService.`getNextSequence(Integer tenant, SequenceType sequenceType)`
  Atomically find a sequence and update it.
  `String`
  VitamCounterService.`getNextSequenceAsString(Integer tenant, SequenceType sequenceType)`
  Atomically find a sequence and update it.
  `Integer`
  VitamCounterService.`getSequence(Integer tenant, SequenceType sequenceType)`
  Get the last sequence functional collection
  `VitamSequence`
  VitamCounterService.`getSequenceDocument(Integer tenant, SequenceType sequenceType)`

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

  Subclasses of ReferentialException in fr.gouv.vitam.functional.administration.common.exception
  Modifier and Type
  Class
  Description
  `class`
  `AccessionRegisterException`
  Accession Register Exception
  `class`
  `AdminManagementClientBadRequestException`
  `class`
  `AdminManagementClientServerException`
  Accession Register Exception
  `class`
  `AgencyImportDeletionException`
  AgencyImportDeletionException manage File Rules Exception
  `class`
  `FileFormatException`
  FileFormatException error
  `class`
  `FileFormatNotFoundException`
  Exception indicating that there is not file containing file format vitam.
  `class`
  `FileRulesCsvException`
  Exception throw when csv to import is not well format or is bad to parse
  `class`
  `FileRulesDeleteException`
  Exception thrown when user want to be delete a unit linked to a fileRules
  `class`
  `FileRulesDurationException`
  Exception throw when rule duration is inferior than duration in configuration
  `class`
  `FileRulesException`
  FileRulesException manage File Rules Exception
  `class`
  `FileRulesIllegalDurationModeUpdateException`
  Exception thrown when duration mode update in illegal.
  `class`
  `FileRulesNotFoundException`
  Exception indicating that there is not file containing file format vitam.
  `class`
  `FileRulesReadException`
  `class`
  `InvalidFileException`
  `class`
  `InvalidFileFormatParseException`
  Exception indicating the invalid file format XLM when parsing it
  `class`
  `InvalidFileRulesParseException`
  Exception indicating the invalid file format XLM when parsing it
  `class`
  `JsonNodeFormatCreationException`
  Exception when creating a json object node from invalid object
  `class`
  `ReferentialImportInProgressException`
  Exception thrown when a file rules import is already in progress
  `class`
  `ReferentialNotFoundException`
  Exception indicating that Referential Not Found.

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

  Methods in fr.gouv.vitam.functional.administration.common.server that throw ReferentialException
  Modifier and Type
  Method
  Description
  `final void`
  ElasticsearchAccessFunctionalAdmin.`addIndex(FunctionalAdminCollections collection)`
  Add a type to an index
  `DbRequestResult`
  MongoDbAccessReferential.`deleteCollectionForTesting(FunctionalAdminCollections collection)`
  Delete FileFormat collections
  `DbRequestResult`
  MongoDbAccessReferential.`deleteCollectionForTesting(FunctionalAdminCollections collection, Delete delete)`
  `DbRequestResult`
  MongoDbAccessAdminImpl.`deleteDocument(com.fasterxml.jackson.databind.JsonNode delete, FunctionalAdminCollections collection)`
  `DbRequestResult`
  MongoDbAccessReferential.`deleteDocument(com.fasterxml.jackson.databind.JsonNode delete, FunctionalAdminCollections collection)`
  `DbRequestResult`
  MongoDbAccessAdminImpl.`findDocuments(com.fasterxml.jackson.databind.JsonNode select, FunctionalAdminCollections collection)`
  `DbRequestResult`
  MongoDbAccessReferential.`findDocuments(com.fasterxml.jackson.databind.JsonNode select, FunctionalAdminCollections collection)`
  `DbRequestResult`
  MongoDbAccessAdminImpl.`findDocumentsWithoutRestrictionOnCurrentTenant(com.fasterxml.jackson.databind.JsonNode select, FunctionalAdminCollections collection)`
  `DbRequestResult`
  MongoDbAccessReferential.`findDocumentsWithoutRestrictionOnCurrentTenant(com.fasterxml.jackson.databind.JsonNode select, FunctionalAdminCollections collection)`
  find documents Without Restriction On CurrentTenant
  `VitamDocument<?>`
  MongoDbAccessReferential.`getDocumentById(String id, FunctionalAdminCollections collection)`
  `VitamDocument<?>`
  MongoDbAccessReferential.`getDocumentByUniqueId(String id, FunctionalAdminCollections collection, String field)`
  `DbRequestResult`
  MongoDbAccessAdminImpl.`insertDocument(com.fasterxml.jackson.databind.JsonNode json, FunctionalAdminCollections collection)`
  `DbRequestResult`
  MongoDbAccessReferential.`insertDocument(com.fasterxml.jackson.databind.JsonNode jsonNode, FunctionalAdminCollections collection)`
  insert documents
  `DbRequestResult`
  MongoDbAccessAdminImpl.`insertDocuments(com.fasterxml.jackson.databind.node.ArrayNode arrayNode, FunctionalAdminCollections collection)`
  `DbRequestResult`
  MongoDbAccessAdminImpl.`insertDocuments(com.fasterxml.jackson.databind.node.ArrayNode arrayNode, FunctionalAdminCollections collection, Integer version)`
  `DbRequestResult`
  MongoDbAccessReferential.`insertDocuments(com.fasterxml.jackson.databind.node.ArrayNode arrayNode, FunctionalAdminCollections collection)`
  insert documents
  `DbRequestResult`
  MongoDbAccessReferential.`insertDocuments(com.fasterxml.jackson.databind.node.ArrayNode arrayNode, FunctionalAdminCollections collection, Integer version)`
  insert documents
  `protected final co.elastic.clients.elasticsearch.core.search.ResponseBody<com.fasterxml.jackson.databind.node.ObjectNode>`
  ElasticsearchAccessFunctionalAdmin.`search(FunctionalAdminCollections collection, co.elastic.clients.elasticsearch._types.query_dsl.Query query)`
  `DbRequestResult`
  MongoDbAccessAdminImpl.`updateData(com.fasterxml.jackson.databind.JsonNode update, FunctionalAdminCollections collection)`
  `DbRequestResult`
  MongoDbAccessAdminImpl.`updateData(com.fasterxml.jackson.databind.JsonNode update, FunctionalAdminCollections collection, Integer version)`
  `DbRequestResult`
  MongoDbAccessReferential.`updateData(com.fasterxml.jackson.databind.JsonNode update, FunctionalAdminCollections collection)`
  Update with queryDsl
  `DbRequestResult`
  MongoDbAccessReferential.`updateData(com.fasterxml.jackson.databind.JsonNode update, FunctionalAdminCollections collection, Integer version)`
  Update with queryDsl

- ## Uses of ReferentialException in fr.gouv.vitam.functional.administration.core.accession.register

  Methods in fr.gouv.vitam.functional.administration.core.accession.register that throw ReferentialException
  Modifier and Type
  Method
  Description
  `void`
  ReferentialAccessionRegisterImpl.`createAccessionRegisterSymbolic(List<Integer> tenants)`
  `void`
  ReferentialAccessionRegisterImpl.`createOrUpdateAccessionRegister(AccessionRegisterDetailModel registerDetail)`
  `RequestResponseOK<AccessionRegisterSymbolicModel>`
  ReferentialAccessionRegisterImpl.`findAccessionRegisterSymbolic(com.fasterxml.jackson.databind.JsonNode queryDsl)`
  Find the accession register symbolic filtered by the query dsl, if an empty query dsl is provided, the last 20 accession register symbolics will be returned.
  `RequestResponseOK<AccessionRegisterDetail>`
  ReferentialAccessionRegisterImpl.`findDetail(com.fasterxml.jackson.databind.JsonNode select)`
  search for an accession register's operation detail
  `RequestResponseOK<AccessionRegisterSummary>`
  ReferentialAccessionRegisterImpl.`findDocuments(com.fasterxml.jackson.databind.JsonNode select)`
  search for an accession register's summary
  `void`
  ReferentialAccessionRegisterImpl.`migrateAccessionRegister(AccessionRegisterDetailModel accessionRegister, List<String> fieldsToUpdate)`

- ## Uses of ReferentialException in fr.gouv.vitam.functional.administration.core.agencies

  Methods in fr.gouv.vitam.functional.administration.core.agencies that throw ReferentialException
  Modifier and Type
  Method
  Description
  `DbRequestResult`
  AgenciesService.`findAgencies(com.fasterxml.jackson.databind.JsonNode queryDsl)`
  Find agencies with a specific query
  `AgenciesImportResult`
  AgenciesService.`parseFile(File csvFile)`
  convert csv file into a set of AgenciesModel
  `Set<AgenciesModel>`
  AgenciesService.`retrieveAgenciesInDb()`
  Retrieve agencies in database

- ## Uses of ReferentialException in fr.gouv.vitam.functional.administration.core.archiveunitprofiles

  Methods in fr.gouv.vitam.functional.administration.core.archiveunitprofiles that throw ReferentialException
  Modifier and Type
  Method
  Description
  `RequestResponseOK<ArchiveUnitProfileModel>`
  ArchiveUnitProfileService.`findArchiveUnitProfiles(com.fasterxml.jackson.databind.JsonNode queryDsl)`
  find archive unit profiles by QueryDsl
  `RequestResponseOK<ArchiveUnitProfileModel>`
  ArchiveUnitProfileServiceImpl.`findArchiveUnitProfiles(com.fasterxml.jackson.databind.JsonNode queryDsl)`
  `ArchiveUnitProfileModel`
  ArchiveUnitProfileServiceImpl.`findByIdentifier(String id)`

- ## Uses of ReferentialException in fr.gouv.vitam.functional.administration.core.archiveunitprofilesSchema

  Methods in fr.gouv.vitam.functional.administration.core.archiveunitprofilesSchema that throw ReferentialException
  Modifier and Type
  Method
  Description
  `List<CombinedSchemaModel>`
  ArchiveUnitProfileSchemaService.`getCombinedSchemaModelsById(String identifier)`
  find archive unit profiles by QueryDsl
  `List<CombinedSchemaModel>`
  ArchiveUnitProfileSchemaServiceImpl.`getCombinedSchemaModelsById(String identifier)`

- ## Uses of ReferentialException in fr.gouv.vitam.functional.administration.core.context

  Methods in fr.gouv.vitam.functional.administration.core.context that throw ReferentialException
  Modifier and Type
  Method
  Description
  `DbRequestResult`
  ContextService.`findContexts(com.fasterxml.jackson.databind.JsonNode queryDsl)`
  Search for contexts
  `DbRequestResult`
  ContextServiceImpl.`findContexts(com.fasterxml.jackson.databind.JsonNode queryDsl)`
  `ContextModel`
  ContextService.`findOneContextById(String id)`
  Find a context by its id
  `ContextModel`
  ContextServiceImpl.`findOneContextById(String id)`
  `boolean`
  ContextService.`securityProfileIsUsedInContexts(String securityProfileId)`
  `boolean`
  ContextServiceImpl.`securityProfileIsUsedInContexts(String securityProfileId)`
  `List<ContextValidator.ContextRejectionCause>`
  ContextValidator.`validate(ContextModel context)`
  Validate a context object

- ## Uses of ReferentialException in fr.gouv.vitam.functional.administration.core.contract

  Methods in fr.gouv.vitam.functional.administration.core.contract that throw ReferentialException
  Modifier and Type
  Method
  Description
  `AccessContractModel`
  AccessContractImpl.`findByIdentifier(String identifier)`
  `static DbRequestResult`
  ContractHelper.`findByIdentifier(String identifier, FunctionalAdminCollections collection, MongoDbAccessReferential mongoAccess)`
  Find contracts by idenfier
  `T`
  ContractService.`findByIdentifier(String identifier)`
  Find contract by identifier
  `IngestContractModel`
  IngestContractImpl.`findByIdentifier(String identifier)`
  `ManagementContractModel`
  ManagementContractImpl.`findByIdentifier(String identifier)`
  `RequestResponseOK<AccessContractModel>`
  AccessContractImpl.`findContracts(com.fasterxml.jackson.databind.JsonNode queryDsl)`
  `RequestResponseOK<T>`
  ContractService.`findContracts(com.fasterxml.jackson.databind.JsonNode queryDsl)`
  find contract by QueryDsl
  `RequestResponseOK<IngestContractModel>`
  IngestContractImpl.`findContracts(com.fasterxml.jackson.databind.JsonNode queryDsl)`
  `RequestResponseOK<ManagementContractModel>`
  ManagementContractImpl.`findContracts(com.fasterxml.jackson.databind.JsonNode queryDsl)`
  `static void`
  ContractHelper.`setIdentifier(boolean slaveMode, AbstractContractModel cm, VitamCounterService vitamCounterService, SequenceType sequenceType)`
  Init idenfier in contract if slave not activated.

- ## Uses of ReferentialException in fr.gouv.vitam.functional.administration.core.format

  Methods in fr.gouv.vitam.functional.administration.core.format that throw ReferentialException
  Modifier and Type
  Method
  Description
  `List<FileFormatModel>`
  ReferentialFormatFileImpl.`checkFile(InputStream xmlPronom)`
  check PRONOM File and return all format as arraynode
  `RequestResponseOK<FileFormat>`
  ReferentialFormatFileImpl.`findDocuments(com.fasterxml.jackson.databind.JsonNode select)`

- ## Uses of ReferentialException in fr.gouv.vitam.functional.administration.core.griffin

  Methods in fr.gouv.vitam.functional.administration.core.griffin that throw ReferentialException
  Modifier and Type
  Method
  Description
  `RequestResponse<GriffinModel>`
  GriffinService.`findGriffin(com.fasterxml.jackson.databind.JsonNode queryDsl)`
  `RequestResponse<PreservationScenarioModel>`
  PreservationScenarioService.`findPreservationScenario(com.fasterxml.jackson.databind.JsonNode queryDsl)`

- ## Uses of ReferentialException in fr.gouv.vitam.functional.administration.core.ontologies

  Methods in fr.gouv.vitam.functional.administration.core.ontologies that throw ReferentialException
  Modifier and Type
  Method
  Description
  `RequestResponseOK<OntologyModel>`
  OntologyService.`findOntologies(com.fasterxml.jackson.databind.JsonNode queryDsl)`
  find an ontology by QueryDsl
  `RequestResponseOK<OntologyModel>`
  OntologyServiceImpl.`findOntologies(com.fasterxml.jackson.databind.JsonNode queryDsl)`
  `RequestResponseOK<OntologyModel>`
  OntologyService.`findOntologiesForCache(com.fasterxml.jackson.databind.JsonNode queryDsl)`
  find an ontology by QueryDsl (find directly in db)

- ## Uses of ReferentialException in fr.gouv.vitam.functional.administration.core.profile

  Methods in fr.gouv.vitam.functional.administration.core.profile that throw ReferentialException
  Modifier and Type
  Method
  Description
  `jakarta.ws.rs.core.Response`
  ProfileService.`downloadProfileFile(String profileIdentifier)`
  download file corresponding to profileIdentifier
  `jakarta.ws.rs.core.Response`
  ProfileServiceImpl.`downloadProfileFile(String profileIdentifier)`
  `ProfileModel`
  ProfileService.`findByIdentifier(String identifier)`
  Find profile by identifier
  `ProfileModel`
  ProfileServiceImpl.`findByIdentifier(String identifier)`
  `RequestResponseOK<ProfileModel>`
  ProfileService.`findProfiles(com.fasterxml.jackson.databind.JsonNode queryDsl)`
  find Profile by QueryDsl
  `RequestResponseOK<ProfileModel>`
  ProfileServiceImpl.`findProfiles(com.fasterxml.jackson.databind.JsonNode queryDsl)`

- ## Uses of ReferentialException in fr.gouv.vitam.functional.administration.core.rules

  Methods in fr.gouv.vitam.functional.administration.core.rules that throw ReferentialException
  Modifier and Type
  Method
  Description
  `RuleImportResultSet`
  RulesManagerFileImpl.`checkFile(Map<String,FileRulesModel> rulesToImport)`
  Checks File : checks if a stream of referential data is valid
  `void`
  RulesManagerFileImpl.`checkRuleConformity(List<Integer> tenants)`
  `RequestResponseOK<FileRules>`
  RulesManagerFileImpl.`findDocuments(com.fasterxml.jackson.databind.JsonNode select)`
  `void`
  RulesManagerFileImpl.`importFile(InputStream rulesFileStream, String filename)`

- ## Uses of ReferentialException in fr.gouv.vitam.functional.administration.core.schema

  Methods in fr.gouv.vitam.functional.administration.core.schema that throw ReferentialException
  Modifier and Type
  Method
  Description
  `List<SchemaResponse>`
  SchemaService.`findObjectGroupInternalSchema()`
  Retrieve Object group schema list
  `List<SchemaResponse>`
  SchemaService.`findUnitInternalSchema()`
  Retrieve the schema list for unit collection
  `List<SchemaResponse>`
  SchemaService.`findUnitSchema()`
  Retrieve internal and external schema list

- ## Uses of ReferentialException in fr.gouv.vitam.functional.administration.core.security.profile

  Methods in fr.gouv.vitam.functional.administration.core.security.profile that throw ReferentialException
  Modifier and Type
  Method
  Description
  `Optional<SecurityProfileModel>`
  SecurityProfileService.`findOneByIdentifier(String identifier)`
  `RequestResponseOK<SecurityProfileModel>`
  SecurityProfileService.`findSecurityProfiles(com.fasterxml.jackson.databind.JsonNode queryDsl)`