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

All Implemented Interfaces:

java.io.Serializable, java.util.Map<java.lang.String,java.lang.Object>, org.bson.conversions.Bson
```
public class AccessContract
extends VitamDocument<AccessContract>
```
Defines an Access contract model for SIP transfer control.

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 contract
`static java.lang.String`	`CREATIONDATE`	the creatation date of contract
`static java.lang.String`	`DEACTIVATIONDATE`	the desactication date of contract
`static java.lang.String`	`DESCRIPTION`	the contract description
`static java.lang.String`	`IDENTIFIER`	the contract id
`static java.lang.String`	`LAST_UPDATE`	the last update of contract
`static java.lang.String`	`NAME`	the contract name
`static java.lang.String`	`ORIGINATINGAGENCIES`	the originating agencies
`static java.lang.String`	`STATUS`	the contract status

Fields 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

Constructors
Constructor	Description
`AccessContract()`	Empty Constructor
`AccessContract(com.fasterxml.jackson.databind.JsonNode content)`
`AccessContract(java.lang.Integer tenantId)`
`AccessContract(java.lang.String content)`
`AccessContract(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 contract description
`java.lang.String`	`getLastupdate()`
`java.lang.String`	`getName()`	Name of the contract
`java.util.Set<java.lang.String>`	`getOriginatingAgencies()`
`ActivationStatus`	`getStatus()`	Get the contract status
`VitamDocument<AccessContract>`	`newInstance(com.fasterxml.jackson.databind.JsonNode content)`	Make a new instance of the document with the given json
`AccessContract`	`setActivationdate(java.lang.String activationdate)`
`AccessContract`	`setCreationdate(java.lang.String creationdate)`
`AccessContract`	`setDeactivationdate(java.lang.String deactivationdate)`
`AccessContract`	`setDescription(java.lang.String description)`	Set or change the contract description
`AccessContract`	`setId(java.lang.String id)`
`AccessContract`	`setLastupdate(java.lang.String lastupdate)`
`AccessContract`	`setName(java.lang.String name)`	Set or change the contract name
`AccessContract`	`setOriginatingAgencies(java.util.Set<java.lang.String> originatingAgencies)`	Set the collection of originating agencies
`AccessContract`	`setStatus(ActivationStatus status)`	Set or change the contract 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 org.bson.conversions.Bson
toBsonDocument

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 contract id
    
    See Also:
    
    Constant Field Values
  - NAME
```
public static final java.lang.String NAME
```
    the contract name
    
    See Also:
    
    Constant Field Values
  - DESCRIPTION
```
public static final java.lang.String DESCRIPTION
```
    the contract description
    
    See Also:
    
    Constant Field Values
  - STATUS
```
public static final java.lang.String STATUS
```
    the contract status
    
    See Also:
    
    Constant Field Values
  - ORIGINATINGAGENCIES
```
public static final java.lang.String ORIGINATINGAGENCIES
```
    the originating agencies
    
    See Also:
    
    Constant Field Values
  - CREATIONDATE
```
public static final java.lang.String CREATIONDATE
```
    the creatation date of contract
    
    See Also:
    
    Constant Field Values
  - LAST_UPDATE
```
public static final java.lang.String LAST_UPDATE
```
    the last update of contract
    
    See Also:
    
    Constant Field Values
  - ACTIVATIONDATE
```
public static final java.lang.String ACTIVATIONDATE
```
    the activation date of contract
    
    See Also:
    
    Constant Field Values
  - DEACTIVATIONDATE
```
public static final java.lang.String DEACTIVATIONDATE
```
    the desactication date of contract
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AccessContract
```
public AccessContract()
```
    Empty Constructor
  - AccessContract
```
public AccessContract(org.bson.Document document)
```
    Constructor
    
    Parameters:
    
    document - data in format Document to create contact
  - AccessContract
```
public AccessContract(com.fasterxml.jackson.databind.JsonNode content)
```
    Parameters:
    
    content - in format JsonNode to create contract
  - AccessContract
```
public AccessContract(java.lang.String content)
```
    Parameters:
    
    content - in format String to create contract
  - AccessContract
```
public AccessContract(java.lang.Integer tenantId)
```
    Parameters:
    
    tenantId - the working tenant
- Method Detail
  - newInstance
```
public VitamDocument<AccessContract> 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<AccessContract>
    
    Parameters:
    
    content - document structure as json
    
    Returns:
    
    new document with the json as content
  - setId
```
public AccessContract setId(java.lang.String id)
```
    Parameters:
    
    id - the id of access contract
    
    Returns:
    
    AccessionRegisterDetail
  - getName
```
public java.lang.String getName()
```
    Name of the contract
    
    Returns:
    
    name of contract
  - setName
```
public AccessContract setName(java.lang.String name)
```
    Set or change the contract name
    
    Parameters:
    
    name - to set
    
    Returns:
    
    this
  - getDescription
```
public java.lang.String getDescription()
```
    Get the contract description
    
    Returns:
    
    this
  - setDescription
```
public AccessContract setDescription(java.lang.String description)
```
    Set or change the contract description
    
    Parameters:
    
    description - to set to contact
    
    Returns:
    
    this
  - getStatus
```
public ActivationStatus getStatus()
```
    Get the contract status
    
    Returns:
    
    status of access contact
  - setStatus
```
public AccessContract setStatus(ActivationStatus status)
```
    Set or change the contract status
    
    Parameters:
    
    status - to set
    
    Returns:
    
    this
  - getOriginatingAgencies
```
public java.util.Set<java.lang.String> getOriginatingAgencies()
```
    Returns:
    
    collection of originating agencies
  - setOriginatingAgencies
```
public AccessContract setOriginatingAgencies(java.util.Set<java.lang.String> originatingAgencies)
```
    Set the collection of originating agencies
    
    Parameters:
    
    originatingAgencies -
    
    Returns:
    
    this
  - getCreationdate
```
public java.lang.String getCreationdate()
```
    Returns:
    
    creation date of contract
  - setCreationdate
```
public AccessContract setCreationdate(java.lang.String creationdate)
```
    Parameters:
    
    creationdate - to set
    
    Returns:
    
    this
  - getLastupdate
```
public java.lang.String getLastupdate()
```
    Returns:
    
    last update of contract
  - setLastupdate
```
public AccessContract setLastupdate(java.lang.String lastupdate)
```
    Parameters:
    
    lastupdate - to set
    
    Returns:
    
    this
  - getActivationdate
```
public java.lang.String getActivationdate()
```
    Returns:
    
    activation date of contract
  - setActivationdate
```
public AccessContract setActivationdate(java.lang.String activationdate)
```
    Parameters:
    
    activationdate - to set
    
    Returns:
    
    this
  - getDeactivationdate
```
public java.lang.String getDeactivationdate()
```
    Returns:
    
    desactivation date of contract
  - setDeactivationdate
```
public AccessContract setDeactivationdate(java.lang.String deactivationdate)
```
    Parameters:
    
    deactivationdate - to set
    
    Returns:
    
    this

Class AccessContract

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

Fields inherited from interface org.bson.conversions.Bson

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 org.bson.conversions.Bson

Methods inherited from interface java.util.Map

Field Detail

IDENTIFIER

NAME

DESCRIPTION

STATUS

ORIGINATINGAGENCIES

CREATIONDATE

LAST_UPDATE

ACTIVATIONDATE

DEACTIVATIONDATE

Constructor Detail

AccessContract

AccessContract

AccessContract

AccessContract

AccessContract

Method Detail

newInstance

setId

getName

setName

getDescription

setDescription

getStatus

setStatus

getOriginatingAgencies

setOriginatingAgencies

getCreationdate

setCreationdate

getLastupdate

setLastupdate

getActivationdate

setActivationdate

getDeactivationdate

setDeactivationdate