Class IngestContract
java.lang.Object
org.bson.Document
fr.gouv.vitam.common.database.server.mongodb.VitamDocument<IngestContract>
fr.gouv.vitam.functional.administration.common.IngestContract
- All Implemented Interfaces:
Serializable
,Map<String,
,Object> org.bson.conversions.Bson
Defines an Ingest contract model for SIP transfer control.
It's an implementation of the SEDA specification and NF Z44022 MEDONA concerning the communication between a
TransferringAgency and an ArchivalAgency.
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
the activation date of contractstatic final String
Archive profilestatic final String
check parent link status (ACTIVE / INACTIVE)static final String
the creatation date of contractstatic final String
the desactication date of contractstatic final String
the contract descriptionstatic final String
the everydataobjectversion false by defaultstatic final String
the EveryFormatType true by defaultstatic final String
the FormatUnidentifiedAuthorized false by defaultstatic final String
the contract idstatic final String
the last update of contractstatic final String
the identifier of a management contractstatic final String
the MasterMandatory true by defaultstatic final String
the contract namestatic final String
the contract 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
ConstructorDescriptionEmpty ConstructorIngestContract
(com.fasterxml.jackson.databind.JsonNode content) IngestContract
(Integer tenantId) IngestContract
(String content) IngestContract
(org.bson.Document document) Constructor -
Method Summary
Modifier and TypeMethodDescriptionGet the contract check ParentLink statusGet the contract descriptiongetName()
Name of the contractGet the contract statusnewInstance
(com.fasterxml.jackson.databind.JsonNode content) Make a new instance of the document with the given jsonsetActivationdate
(String activationdate) setArchiveProfiles
(Set<String> archiveProfiles) Set the collection of archive profilessetCheckParentLink
(IngestContractCheckState checkParentLink) Set or change the contract statussetCreationdate
(String creationdate) setDeactivationdate
(String deactivationdate) setDescription
(String description) Set or change the contract descriptionsetEveryDataObjectVersion
(boolean everyDataObjectVersion) setEveryFormatType
(boolean everyFormatType) setFormatUnidentifiedAuthorized
(boolean formatUnidentifiedAuthorized) setLastupdate
(String lastupdate) setManagementContractId
(String managementContractId) setMasterMandatory
(boolean masterMandatory) Set or change the contract namesetStatus
(ActivationStatus status) Set or change the contract 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 contract id- See Also:
-
NAME
the contract name- See Also:
-
DESCRIPTION
the contract description- See Also:
-
STATUS
the contract status- See Also:
-
CHECKPARENTLINK
check parent link status (ACTIVE / INACTIVE)- See Also:
-
ARCHIVEPROFILES
Archive profile- See Also:
-
CREATIONDATE
the creatation date of contract- See Also:
-
LAST_UPDATE
the last update of contract- See Also:
-
ACTIVATIONDATE
the activation date of contract- See Also:
-
DEACTIVATIONDATE
the desactication date of contract- See Also:
-
EVERYDATAOBJECTVERSION
the everydataobjectversion false by default- See Also:
-
MASTERMANDATORY
the MasterMandatory true by default- See Also:
-
FORMATUNIDENTIFIEDAUTHORIZED
the FormatUnidentifiedAuthorized false by default- See Also:
-
EVERYFORMATTYPE
the EveryFormatType true by default- See Also:
-
MANAGEMENTCONTRACTID
the identifier of a management contract- See Also:
-
-
Constructor Details
-
IngestContract
public IngestContract()Empty Constructor -
IngestContract
public IngestContract(org.bson.Document document) Constructor- Parameters:
document
- data in format Document to create contact
-
IngestContract
public IngestContract(com.fasterxml.jackson.databind.JsonNode content) - Parameters:
content
- in format JsonNode to create contract
-
IngestContract
- Parameters:
content
- in format String to create contract
-
IngestContract
- Parameters:
tenantId
- the working tenant
-
-
Method Details
-
setId
- Parameters:
id
- the id of ingest contract- Returns:
- AccessionRegisterDetail
-
newInstance
Description copied from class:VitamDocument
Make a new instance of the document with the given json- Specified by:
newInstance
in classVitamDocument<IngestContract>
- Parameters:
content
- document structure as json- Returns:
- new document with the json as content
-
getName
Name of the contract- Returns:
- name of contract
-
setName
Set or change the contract name- Parameters:
name
- to set- Returns:
- this
-
getDescription
Get the contract description- Returns:
- this
-
setDescription
Set or change the contract description- Parameters:
description
- to set to contact- Returns:
- this
-
getStatus
Get the contract status- Returns:
- status of ingest contact
-
setStatus
Set or change the contract status- Parameters:
status
- to set- Returns:
- this
-
setCheckParentLink
Set or change the contract status- Parameters:
checkParentLink
- to set- Returns:
- this
-
getCheckParentLink
Get the contract check ParentLink status- Returns:
- status of checkParentLink for this ingest contact
-
getArchiveProfiles
- Returns:
- collection of archive profiles
-
setArchiveProfiles
Set the collection of archive profiles- Parameters:
archiveProfiles
-- Returns:
- this
-
getCreationdate
- Returns:
- creation date of contract
-
setCreationdate
- Parameters:
creationdate
- to set- Returns:
- this
-
getLastupdate
- Returns:
- last update of contract
-
setLastupdate
- Parameters:
lastupdate
- to set- Returns:
- this
-
getActivationdate
- Returns:
- activation date of contract
-
setActivationdate
- Parameters:
activationdate
- to set- Returns:
- this
-
getDeactivationdate
- Returns:
- desactivation date of contract
-
setDeactivationdate
- Parameters:
deactivationdate
- to set- Returns:
- this
-
getEveryDataObjectVersion
-
setEveryDataObjectVersion
-
getMasterMandatory
-
setMasterMandatory
-
getEveryFormatType
-
setEveryFormatType
-
getFormatUnidentifiedAuthorized
-
setFormatUnidentifiedAuthorized
-
setManagementContractId
-
getManagementContractId
-