java.lang.Object
- org.bson.Document
- - fr.gouv.vitam.common.database.server.mongodb.VitamDocument<Profile>
  - - fr.gouv.vitam.functional.administration.common.Profile

All Implemented Interfaces:

java.io.Serializable, java.util.Map<java.lang.String,java.lang.Object>, org.bson.conversions.Bson
```
public class Profile
extends VitamDocument<Profile>
```
Defines a Profile collection.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`ACTIVATIONDATE`	the activation date of the profile
`static java.lang.String`	`CREATIONDATE`	the creatation date of the profile
`static java.lang.String`	`DEACTIVATIONDATE`	the desactication date of the profile
`static java.lang.String`	`DESCRIPTION`	the profile description
`static java.lang.String`	`FORMAT`	the profile file format
`static java.lang.String`	`IDENTIFIER`	the profile id
`static java.lang.String`	`LAST_UPDATE`	the last update of profile
`static java.lang.String`	`NAME`	the profile name
`static java.lang.String`	`PATH`	the profile file path in storage
`static java.lang.String`	`STATUS`	the profile status

Fields inherited from class fr.gouv.vitam.common.database.server.mongodb.VitamDocument
ES_FILTER_OUT, ID, IMPLEMENTATIONVERSION, SCORE, SEDAVERSION, TENANT_ID, VERSION

Constructor Summary

Constructors
Constructor	Description
`Profile()`	Empty Constructor
`Profile(com.fasterxml.jackson.databind.JsonNode content)`
`Profile(java.lang.Integer tenantId)`
`Profile(java.lang.String content)`
`Profile(org.bson.Document document)`	Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getActivationdate()`
`java.lang.String`	`getCreationdate()`
`java.lang.String`	`getDeactivationdate()`
`java.lang.String`	`getDescription()`	Get the profile description
`ProfileFormat`	`getFormat()`	The profile file format If toJson called without MongoClient configuration this will thow codec exception
`java.lang.String`	`getIdentifier()`	The profile id
`java.lang.String`	`getLastupdate()`
`java.lang.String`	`getName()`	Name of the profile
`java.lang.String`	`getPath()`	The profile file path in storage
`ProfileStatus`	`getStatus()`	Get the profile status If toJson called without MongoClient configuration this will thow codec exception
`VitamDocument<Profile>`	`newInstance(com.fasterxml.jackson.databind.JsonNode content)`	Make a new instance of the document with the given json
`Profile`	`setActivationdate(java.lang.String activationdate)`
`Profile`	`setCreationdate(java.lang.String creationdate)`
`Profile`	`setDeactivationdate(java.lang.String deactivationdate)`
`Profile`	`setDescription(java.lang.String description)`	Set or change the profile description
`Profile`	`setFormat(ProfileFormat format)`	Set or change the profile format (xsd, rng, ...)
`Profile`	`setId(java.lang.String id)`
`Profile`	`setIdentifier(java.lang.String identifier)`	Set or change the profile id, the identifier must be unique by tenant
`Profile`	`setLastupdate(java.lang.String lastupdate)`
`Profile`	`setName(java.lang.String name)`	Set or change the profile name
`Profile`	`setPath(java.lang.String path)`	Set or change the profile path
`Profile`	`setStatus(ProfileStatus status)`	Set or change the profile status

Methods inherited from class fr.gouv.vitam.common.database.server.mongodb.VitamDocument
checkId, getConcernedDiffLines, getId, getOriginalDiffLines, getTenantId, getUnifiedDiff, getVersion, toString, toStringDirect

Methods inherited from class org.bson.Document
append, clear, containsKey, containsValue, entrySet, equals, get, get, get, getBoolean, getBoolean, getDate, getDouble, getEmbedded, getEmbedded, getInteger, getInteger, getList, getList, getLong, getObjectId, getString, hashCode, isEmpty, keySet, parse, parse, put, putAll, remove, size, toBsonDocument, toJson, toJson, toJson, toJson, values

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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Field Detail
  - IDENTIFIER
```
public static final java.lang.String IDENTIFIER
```
    the profile id
    
    See Also:
    
    Constant Field Values
  - NAME
```
public static final java.lang.String NAME
```
    the profile name
    
    See Also:
    
    Constant Field Values
  - DESCRIPTION
```
public static final java.lang.String DESCRIPTION
```
    the profile description
    
    See Also:
    
    Constant Field Values
  - STATUS
```
public static final java.lang.String STATUS
```
    the profile status
    
    See Also:
    
    Constant Field Values
  - FORMAT
```
public static final java.lang.String FORMAT
```
    the profile file format
    
    See Also:
    
    Constant Field Values
  - PATH
```
public static final java.lang.String PATH
```
    the profile file path in storage
    
    See Also:
    
    Constant Field Values
  - CREATIONDATE
```
public static final java.lang.String CREATIONDATE
```
    the creatation date of the profile
    
    See Also:
    
    Constant Field Values
  - LAST_UPDATE
```
public static final java.lang.String LAST_UPDATE
```
    the last update of profile
    
    See Also:
    
    Constant Field Values
  - ACTIVATIONDATE
```
public static final java.lang.String ACTIVATIONDATE
```
    the activation date of the profile
    
    See Also:
    
    Constant Field Values
  - DEACTIVATIONDATE
```
public static final java.lang.String DEACTIVATIONDATE
```
    the desactication date of the profile
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Profile
```
public Profile()
```
    Empty Constructor
  - Profile
```
public Profile(org.bson.Document document)
```
    Constructor
    
    Parameters:
    
    document - data in format Document to create contact
  - Profile
```
public Profile(com.fasterxml.jackson.databind.JsonNode content)
```
    Parameters:
    
    content - in format JsonNode to create profile
  - Profile
```
public Profile(java.lang.String content)
```
    Parameters:
    
    content - in format String to create profile
  - Profile
```
public Profile(java.lang.Integer tenantId)
```
    Parameters:
    
    tenantId - the working tenant
- Method Detail
  - newInstance
```
public VitamDocument<Profile> newInstance(com.fasterxml.jackson.databind.JsonNode content)
```
    Description copied from class: VitamDocument
    
    Make a new instance of the document with the given json
    
    Specified by:
    
    newInstance in class VitamDocument<Profile>
    
    Parameters:
    
    content - document structure as json
    
    Returns:
    
    new document with the json as content
  - setId
```
public Profile setId(java.lang.String id)
```
    Parameters:
    
    id - the id of ingest profile
    
    Returns:
    
    AccessionRegisterDetail
  - getIdentifier
```
public java.lang.String getIdentifier()
```
    The profile id
    
    Returns:
    
    the id of the profile
  - setIdentifier
```
public Profile setIdentifier(java.lang.String identifier)
```
    Set or change the profile id, the identifier must be unique by tenant
    
    Parameters:
    
    identifier -
    
    Returns:
    
    this
  - getName
```
public java.lang.String getName()
```
    Name of the profile
    
    Returns:
    
    name of profile
  - setName
```
public Profile setName(java.lang.String name)
```
    Set or change the profile name
    
    Parameters:
    
    name - to set
    
    Returns:
    
    this
  - getDescription
```
public java.lang.String getDescription()
```
    Get the profile description
    
    Returns:
    
    this
  - setDescription
```
public Profile setDescription(java.lang.String description)
```
    Set or change the profile description
    
    Parameters:
    
    description - to set to contact
    
    Returns:
    
    this
  - getStatus
```
public ProfileStatus getStatus()
```
    Get the profile status If toJson called without MongoClient configuration this will thow codec exception
    
    Returns:
    
    status of ingest contact
  - setStatus
```
public Profile setStatus(ProfileStatus status)
```
    Set or change the profile status
    
    Parameters:
    
    status - to set
    
    Returns:
    
    this
  - setFormat
```
public Profile setFormat(ProfileFormat format)
```
    Set or change the profile format (xsd, rng, ...)
    
    Parameters:
    
    format -
    
    Returns:
    
    this
  - getPath
```
public java.lang.String getPath()
```
    The profile file path in storage
    
    Returns:
    
    the profile path
  - setPath
```
public Profile setPath(java.lang.String path)
```
    Set or change the profile path
    
    Parameters:
    
    path -
    
    Returns:
    
    this
  - getFormat
```
public ProfileFormat getFormat()
```
    The profile file format If toJson called without MongoClient configuration this will thow codec exception
    
    Returns:
    
    the profile format
  - getCreationdate
```
public java.lang.String getCreationdate()
```
    Returns:
    
    creation date of profile
  - setCreationdate
```
public Profile setCreationdate(java.lang.String creationdate)
```
    Parameters:
    
    creationdate - to set
    
    Returns:
    
    this
  - getLastupdate
```
public java.lang.String getLastupdate()
```
    Returns:
    
    last update of profile
  - setLastupdate
```
public Profile setLastupdate(java.lang.String lastupdate)
```
    Parameters:
    
    lastupdate - to set
    
    Returns:
    
    this
  - getActivationdate
```
public java.lang.String getActivationdate()
```
    Returns:
    
    activation date of profile
  - setActivationdate
```
public Profile setActivationdate(java.lang.String activationdate)
```
    Parameters:
    
    activationdate - to set
    
    Returns:
    
    this
  - getDeactivationdate
```
public java.lang.String getDeactivationdate()
```
    Returns:
    
    desactivation date of profile
  - setDeactivationdate
```
public Profile setDeactivationdate(java.lang.String deactivationdate)
```
    Parameters:
    
    deactivationdate - to set
    
    Returns:
    
    this

Class Profile

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class fr.gouv.vitam.common.database.server.mongodb.VitamDocument

Constructor Summary

Method Summary

Methods inherited from class fr.gouv.vitam.common.database.server.mongodb.VitamDocument

Methods inherited from class org.bson.Document

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Field Detail

IDENTIFIER

NAME

DESCRIPTION

STATUS

FORMAT

PATH

CREATIONDATE

LAST_UPDATE

ACTIVATIONDATE

DEACTIVATIONDATE

Constructor Detail

Profile

Profile

Profile

Profile

Profile

Method Detail

newInstance

setId

getIdentifier

setIdentifier

getName

setName

getDescription

setDescription

getStatus

setStatus

setFormat

getPath

setPath

getFormat

getCreationdate

setCreationdate

getLastupdate

setLastupdate

getActivationdate

setActivationdate

getDeactivationdate

setDeactivationdate