fr.gouv.vitam.functional.administration.common

Class Agencies

java.lang.Object

org.bson.Document

fr.gouv.vitam.common.database.server.mongodb.VitamDocument<Agencies>

fr.gouv.vitam.functional.administration.common.Agencies

All Implemented Interfaces:

Serializable, Map<String,Object>, org.bson.conversions.Bson

public class Agencies
extends VitamDocument<Agencies>

Defines a Agency 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	DESCRIPTION the Agency description
static String	IDENTIFIER the Agency id
static String	NAME the Agency name

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 and Description
Agencies() /** Empty Constructor
Agencies(org.bson.Document document) Constructor
Agencies(Integer tenantId)
Agencies(com.fasterxml.jackson.databind.JsonNode content)
Agencies(String content)

Method Summary

Modifier and Type	Method and Description
String	getDescription() Get the Agency description
String	getIdentifier() Get the Agency Identifier
String	getName() Get the Agency name
VitamDocument<Agencies>	newInstance(com.fasterxml.jackson.databind.JsonNode content) Make a new instance of the document with the given json
Agencies	setDescription(String description) Set or change the Agency description
Agencies	setIdentifier(String identifier) Set or change the Agency identifier
Agencies	setName(String name) Set or change the Agency name
AgenciesModel	wrap()

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 Agency id

See Also:

Constant Field Values

NAME

public static final String NAME

the Agency name

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

the Agency description

See Also:

Constant Field Values

Constructor Detail

Agencies

public Agencies()

/** Empty Constructor

Agencies

public Agencies(Integer tenantId)

Parameters:

tenantId - the working tenant

Agencies

public Agencies(org.bson.Document document)

Constructor

Parameters:

document - data in format Document to create agency

Agencies

public Agencies(com.fasterxml.jackson.databind.JsonNode content)

Parameters:

content - in format JsonNode to create agency

Agencies

public Agencies(String content)

Parameters:

content - in format String to create agency

Method Detail

newInstance

public VitamDocument<Agencies> 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<Agencies>

Parameters:

content - document structure as json

Returns:

new document with the json as content

getDescription

public String getDescription()

Get the Agency description

Returns:

this

setDescription

public Agencies setDescription(String description)

Set or change the Agency description

Parameters:

description - to set to Agency

Returns:

this

getIdentifier

public String getIdentifier()

Get the Agency Identifier

Returns:

this

setIdentifier

public Agencies setIdentifier(String identifier)

Set or change the Agency identifier

Parameters:

identifier - to set to Agency

Returns:

this

getName

public String getName()

Get the Agency name

Returns:

this

setName

public Agencies setName(String name)

Set or change the Agency name

Parameters:

name - to set to Agency

Returns:

this

wrap

public AgenciesModel wrap()