FunctionalAdminCollections (Vitam API Reference (1.0.0))

java.lang.Object
- java.lang.Enum<FunctionalAdminCollections>
- - fr.gouv.vitam.functional.administration.common.server.FunctionalAdminCollections

All Implemented Interfaces:

Serializable, Comparable<FunctionalAdminCollections>
```
public enum FunctionalAdminCollections
extends Enum<FunctionalAdminCollections>
```
All collections in functional admin module

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ACCESS_CONTRACT` Access contract collection
`ACCESSION_REGISTER_DETAIL` Accession Register detail Collection
`ACCESSION_REGISTER_SUMMARY` Accession Register summary Collection
`AGENCIES` Agency collection
`CONTEXT` Context collection
`FORMATS` Formats Collection
`INGEST_CONTRACT` Ingest contract collection
`PROFILE` Profile collection
`RULES` Rules Collection
`SECURITY_PROFILE` Security profile collection
`VITAM_SEQUENCE` Access contract collection

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Class<?>`	`getClasz()`
`com.mongodb.client.MongoCollection`	`getCollection()`
`long`	`getCount()`
`ElasticsearchAccessFunctionalAdmin`	`getEsClient()` get ElasticSearch Client
`static FunctionalAdminCollections`	`getFromValue(String collection)` get collection from value.
`static FunctionalAdminCollections`	`getFromVitamCollection(VitamCollection collection)`
`String`	`getName()`
`String`	`getType()`
`VarNameAdapter`	`getVarNameAdapater()`
`VitamCollection`	`getVitamCollection()`
`protected void`	`initialize(ElasticsearchAccessFunctionalAdmin esClient)` Initialize the collection
`protected void`	`initialize(com.mongodb.client.MongoDatabase db, boolean recreate)` Initialize the collection
`static boolean`	`isCollectionMultiTenant(String collectionName)` Check if the collection is multi tenant or not
`boolean`	`isMultitenant()`
`boolean`	`isUsingScore()`
`static FunctionalAdminCollections`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static FunctionalAdminCollections[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - FORMATS
```
public static final FunctionalAdminCollections FORMATS
```
    Formats Collection
  - RULES
```
public static final FunctionalAdminCollections RULES
```
    Rules Collection
  - ACCESSION_REGISTER_SUMMARY
```
public static final FunctionalAdminCollections ACCESSION_REGISTER_SUMMARY
```
    Accession Register summary Collection
  - ACCESSION_REGISTER_DETAIL
```
public static final FunctionalAdminCollections ACCESSION_REGISTER_DETAIL
```
    Accession Register detail Collection
  - INGEST_CONTRACT
```
public static final FunctionalAdminCollections INGEST_CONTRACT
```
    Ingest contract collection
  - ACCESS_CONTRACT
```
public static final FunctionalAdminCollections ACCESS_CONTRACT
```
    Access contract collection
  - VITAM_SEQUENCE
```
public static final FunctionalAdminCollections VITAM_SEQUENCE
```
    Access contract collection
  - PROFILE
```
public static final FunctionalAdminCollections PROFILE
```
    Profile collection
  - AGENCIES
```
public static final FunctionalAdminCollections AGENCIES
```
    Agency collection
  - CONTEXT
```
public static final FunctionalAdminCollections CONTEXT
```
    Context collection
  - SECURITY_PROFILE
```
public static final FunctionalAdminCollections SECURITY_PROFILE
```
    Security profile collection
- Method Detail
  - values
```
public static FunctionalAdminCollections[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (FunctionalAdminCollections c : FunctionalAdminCollections.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static FunctionalAdminCollections valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - isMultitenant
```
public boolean isMultitenant()
```
    Returns:
    
    True if this collection is multitenant
  - isUsingScore
```
public boolean isUsingScore()
```
    Returns:
    
    the usingScore
  - initialize
```
protected void initialize(com.mongodb.client.MongoDatabase db,
                          boolean recreate)
```
    Initialize the collection
    
    Parameters:
    
    db - database type
    
    recreate - true is as recreate type
  - initialize
```
protected void initialize(ElasticsearchAccessFunctionalAdmin esClient)
```
    Initialize the collection
    
    Parameters:
    
    esClient -
  - getName
```
public String getName()
```
    Returns:
    
    the name of the collection
  - getType
```
public String getType()
```
    Returns:
    
    the type
  - getCollection
```
public com.mongodb.client.MongoCollection getCollection()
```
    Returns:
    
    the associated MongoCollection
  - getVitamCollection
```
public VitamCollection getVitamCollection()
```
    Returns:
    
    the associated VitamCollection
  - getClasz
```
protected Class<?> getClasz()
```
    Returns:
    
    the associated class
  - getCount
```
public long getCount()
```
    Returns:
    
    the count of associated MongoCollection
  - getVarNameAdapater
```
public VarNameAdapter getVarNameAdapater()
```
    Returns:
    
    the associated VarNameAdapter
  - getEsClient
```
public ElasticsearchAccessFunctionalAdmin getEsClient()
```
    get ElasticSearch Client
    
    Returns:
    
    client Es
  - getFromVitamCollection
```
public static FunctionalAdminCollections getFromVitamCollection(VitamCollection collection)
```
    Parameters:
    
    collection -
    
    Returns:
    
    the corresponding FunctionalAdminCollections
  - getFromValue
```
public static FunctionalAdminCollections getFromValue(String collection)
```
    get collection from value.
    
    Parameters:
    
    collection -
    
    Returns:
    
    the corresponding FunctionalAdminCollections
  - isCollectionMultiTenant
```
public static boolean isCollectionMultiTenant(String collectionName)
```
    Check if the collection is multi tenant or not
    
    Parameters:
    
    collectionName -
    
    Returns:
    
    true if the collection is multi tenant

Enum FunctionalAdminCollections

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

FORMATS

RULES

ACCESSION_REGISTER_SUMMARY

ACCESSION_REGISTER_DETAIL

INGEST_CONTRACT

ACCESS_CONTRACT

VITAM_SEQUENCE

PROFILE

AGENCIES

CONTEXT

SECURITY_PROFILE

Method Detail

values

valueOf

isMultitenant

isUsingScore

initialize

initialize

getName

getType

getCollection

getVitamCollection

getClasz

getCount

getVarNameAdapater

getEsClient

getFromVitamCollection

getFromValue

isCollectionMultiTenant