Class Profile
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:
Serializable
,Map<String,
,Object> org.bson.conversions.Bson
Defines a Profile collection.
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
the activation date of the profilestatic final String
the creatation date of the profilestatic final String
the desactication date of the profilestatic final String
the profile descriptionstatic final String
the profile file formatstatic final String
the profile idstatic final String
the last update of profilestatic final String
the profile namestatic final String
the profile file path in storagestatic final String
the seda versionstatic final String
the profile statusFields inherited from class fr.gouv.vitam.common.database.server.mongodb.VitamDocument
ES_FILTER_OUT, ID, IMPLEMENTATIONVERSION, SCORE, SEDAVERSION, TENANT_ID, VERSION
Fields inherited from interface org.bson.conversions.Bson
DEFAULT_CODEC_REGISTRY
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the profile descriptionThe profile file format If toJson called without MongoClient configuration this will thow codec exceptionThe profile idgetName()
Name of the profilegetPath()
The profile file path in storageGet the profile seda versionGet the profile status If toJson called without MongoClient configuration this will thow codec exceptionnewInstance
(com.fasterxml.jackson.databind.JsonNode content) Make a new instance of the document with the given jsonsetActivationdate
(String activationdate) setCreationdate
(String creationdate) setDeactivationdate
(String deactivationdate) setDescription
(String description) Set or change the profile descriptionsetFormat
(ProfileFormat format) Set or change the profile format (xsd, rng, ...)setIdentifier
(String identifier) Set or change the profile id, the identifier must be unique by tenantsetLastupdate
(String lastupdate) Set or change the profile nameSet or change the profile pathsetSedaVersion
(ProfileSedaVersion sedaVersion) Set or change the seda versionsetStatus
(ProfileStatus status) Set or change the profile statusMethods 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 org.bson.conversions.Bson
toBsonDocument
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
Field Details
-
IDENTIFIER
the profile id- See Also:
-
NAME
the profile name- See Also:
-
DESCRIPTION
the profile description- See Also:
-
STATUS
the profile status- See Also:
-
FORMAT
the profile file format- See Also:
-
SEDA_VERSION
the seda version- See Also:
-
PATH
the profile file path in storage- See Also:
-
CREATIONDATE
the creatation date of the profile- See Also:
-
LAST_UPDATE
the last update of profile- See Also:
-
ACTIVATIONDATE
the activation date of the profile- See Also:
-
DEACTIVATIONDATE
the desactication date of the profile- See Also:
-
-
Constructor Details
-
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
- Parameters:
content
- in format String to create profile
-
Profile
- Parameters:
tenantId
- the working tenant
-
-
Method Details
-
newInstance
Description copied from class:VitamDocument
Make a new instance of the document with the given json- Specified by:
newInstance
in classVitamDocument<Profile>
- Parameters:
content
- document structure as json- Returns:
- new document with the json as content
-
setId
- Parameters:
id
- the id of ingest profile- Returns:
- AccessionRegisterDetail
-
getIdentifier
The profile id- Returns:
- the id of the profile
-
setIdentifier
Set or change the profile id, the identifier must be unique by tenant- Parameters:
identifier
-- Returns:
- this
-
getName
Name of the profile- Returns:
- name of profile
-
setName
Set or change the profile name- Parameters:
name
- to set- Returns:
- this
-
getDescription
Get the profile description- Returns:
- this
-
setDescription
Set or change the profile description- Parameters:
description
- to set to contact- Returns:
- this
-
getStatus
Get the profile status If toJson called without MongoClient configuration this will thow codec exception- Returns:
- status of ingest contact
-
setStatus
Set or change the profile status- Parameters:
status
- to set- Returns:
- this
-
setFormat
Set or change the profile format (xsd, rng, ...)- Parameters:
format
-- Returns:
- this
-
getSedaVersion
Get the profile seda version- Returns:
- the profile seda version
-
setSedaVersion
Set or change the seda version- Parameters:
sedaVersion
-- Returns:
- this
-
getPath
The profile file path in storage- Returns:
- the profile path
-
setPath
Set or change the profile path- Parameters:
path
-- Returns:
- this
-
getFormat
The profile file format If toJson called without MongoClient configuration this will thow codec exception- Returns:
- the profile format
-
getCreationdate
- Returns:
- creation date of profile
-
setCreationdate
- Parameters:
creationdate
- to set- Returns:
- this
-
getLastupdate
- Returns:
- last update of profile
-
setLastupdate
- Parameters:
lastupdate
- to set- Returns:
- this
-
getActivationdate
- Returns:
- activation date of profile
-
setActivationdate
- Parameters:
activationdate
- to set- Returns:
- this
-
getDeactivationdate
- Returns:
- desactivation date of profile
-
setDeactivationdate
- Parameters:
deactivationdate
- to set- Returns:
- this
-