fr.gouv.vitam.functional.administration.common

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

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

Map.Entry<K,V>

Field Summary

Fields

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

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

ES_FILTER_OUT, ID, SCORE, TENANT_ID, VERSION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getActivationdate()
String	getCreationdate()
String	getDeactivationdate()
String	getDescription() Get the profile description
ProfileFormat	getFormat() The profile file format If toJson called without MongoClient configuration this will thow codec exception
String	getIdentifier() The profile id
String	getLastupdate()
String	getName() Name of the profile
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(String activationdate)
Profile	setCreationdate(String creationdate)
Profile	setDeactivationdate(String deactivationdate)
Profile	setDescription(String description) Set or change the profile description
Profile	setFormat(ProfileFormat format) Set or change the profile format (xsd, rng, ...)
Profile	setId(String id)
Profile	setIdentifier(String identifier) Set or change the profile id, the identifier must be unique by tenant
Profile	setLastupdate(String lastupdate)
Profile	setName(String name) Set or change the profile name
Profile	setPath(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, getTenantId, getUnifiedDiff, getVersion, toString, toStringDirect

Methods inherited from class org.bson.Document

append, clear, containsKey, containsValue, entrySet, equals, get, get, getBoolean, getBoolean, getDate, getDouble, getInteger, getInteger, 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 String IDENTIFIER

the profile id

See Also:

Constant Field Values

NAME

public static final String NAME

the profile name

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

the profile description

See Also:

Constant Field Values

STATUS

public static final String STATUS

the profile status

See Also:

Constant Field Values

FORMAT

public static final String FORMAT

the profile file format

See Also:

Constant Field Values

PATH

public static final String PATH

the profile file path in storage

See Also:

Constant Field Values

CREATIONDATE

public static final String CREATIONDATE

the creatation date of the profile

See Also:

Constant Field Values

LAST_UPDATE

public static final String LAST_UPDATE

the last update of profile

See Also:

Constant Field Values

ACTIVATIONDATE

public static final String ACTIVATIONDATE

the activation date of the profile

See Also:

Constant Field Values

DEACTIVATIONDATE

public static final 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(String content)

Parameters:

content - in format String to create profile

Profile

public Profile(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(String id)

Parameters:

id - the id of ingest profile

Returns:

AccessionRegisterDetail

getIdentifier

public String getIdentifier()

The profile id

Returns:

the id of the profile

setIdentifier

public Profile setIdentifier(String identifier)

Set or change the profile id, the identifier must be unique by tenant

Parameters:

identifier -

Returns:

this

getName

public String getName()

Name of the profile

Returns:

name of profile

setName

public Profile setName(String name)

Set or change the profile name

Parameters:

name - to set

Returns:

this

getDescription

public String getDescription()

Get the profile description

Returns:

this

setDescription

public Profile setDescription(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 String getPath()

The profile file path in storage

Returns:

the profile path

setPath

public Profile setPath(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 String getCreationdate()

Returns:

creation date of profile

setCreationdate

public Profile setCreationdate(String creationdate)

Parameters:

creationdate - to set

Returns:

this

getLastupdate

public String getLastupdate()

Returns:

last update of profile

setLastupdate

public Profile setLastupdate(String lastupdate)

Parameters:

lastupdate - to set

Returns:

this

getActivationdate

public String getActivationdate()

Returns:

activation date of profile

setActivationdate

public Profile setActivationdate(String activationdate)

Parameters:

activationdate - to set

Returns:

this

getDeactivationdate

public String getDeactivationdate()

Returns:

desactivation date of profile

setDeactivationdate

public Profile setDeactivationdate(String deactivationdate)

Parameters:

deactivationdate - to set

Returns:

this