Package fr.gouv.vitam.logbook.common.server.database.collections

Class LogbookOperation

java.lang.Object

org.bson.Document

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

fr.gouv.vitam.logbook.common.server.database.collections.LogbookOperation

All Implemented Interfaces:

java.io.Serializable, java.util.Map<java.lang.String,java.lang.Object>, org.bson.conversions.Bson

public class LogbookOperation
extends VitamDocument<LogbookOperation>

Logbook Operation item

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	EVENTS	Events

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	Description
LogbookOperation()
LogbookOperation(com.fasterxml.jackson.databind.JsonNode content)	Constructor for Codec
LogbookOperation(LogbookOperationParameters parameters)	Constructor from LogbookOperationParameters
LogbookOperation(LogbookOperationParameters parameters, boolean forUpdate)	Constructor from LogbookOperationParameters for update purpose
LogbookOperation(java.lang.String content)	Constructor for Codec
LogbookOperation(org.bson.Document content)	Constructor for Codec

Method Summary

Modifier and Type	Method	Description
java.lang.String	getId()
static LogbookParameterName	getIdParameterName()
java.util.List<LogbookOperationParameters>	getOperations(boolean all)	Get back LogbookOperationParameters
VitamDocument<LogbookOperation>	newInstance(com.fasterxml.jackson.databind.JsonNode content)	Make a new instance of the document with the given json

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

checkId, getConcernedDiffLines, 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 java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

EVENTS

public static final java.lang.String EVENTS

Events

See Also:

Constant Field Values

Constructor Detail

LogbookOperation

public LogbookOperation(LogbookOperationParameters parameters)

Constructor from LogbookOperationParameters

Parameters:

parameters - to create logbook operation

Throws:

java.lang.IllegalArgumentException - if argument is null

LogbookOperation

public LogbookOperation(LogbookOperationParameters parameters,
                        boolean forUpdate)

Constructor from LogbookOperationParameters for update purpose

Parameters:

parameters - the logbook parameters

forUpdate - specifies if the parameters should not contain fields for update

Throws:

java.lang.IllegalArgumentException - if argument is null

LogbookOperation

public LogbookOperation(org.bson.Document content)

Constructor for Codec

Parameters:

content - of format Document to create LogbookOperation

LogbookOperation

public LogbookOperation(java.lang.String content)

Constructor for Codec

Parameters:

content - of format String to create LogbookOperation

LogbookOperation

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

Constructor for Codec

Parameters:

content - of format JsonNode to create LogbookOperation

LogbookOperation

public LogbookOperation()

Method Detail

newInstance

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

Parameters:

content - document structure as json

Returns:

new document with the json as content

getIdParameterName

public static LogbookParameterName getIdParameterName()

Returns:

the ParameterName as id in collection

getId

public java.lang.String getId()

Overrides:

getId in class VitamDocument<LogbookOperation>

Returns:

the ID

getOperations

public java.util.List<LogbookOperationParameters> getOperations(boolean all)

Get back LogbookOperationParameters

Parameters:

all - If true returns all items, if false return the first item and last item if any

Returns:

the list of Operations