Package fr.gouv.vitam.logbook.common.parameters

Class LogbookParametersFactory

java.lang.Object

fr.gouv.vitam.logbook.common.parameters.LogbookParametersFactory

public class LogbookParametersFactory
extends Object

Logbook parameters factory
Factory to get LogbookParameters object
Example:

     
      // Retrieves logbook operation parameters with standard required fields
      LogbookOperationParameters parameters = LogbookParametersFactory.getLogbookOperationParameters();

      // Retrieves logbook operation parameters with standard required fields and specifics required fields
      Set<LogbookParameterName> specificMandatoryFields = new HashSet<>()
      // add specific fields
      specificMandatoryFields.add(LogbookParameterName.objectIdentifier);
      specificMandatoryFields.add(LogbookParameterName.agentIdentifier);

      // Retrieves parameter object
      parameters = LogbookParametersFactory.getLogbookOperationParameters(specificMandatoryFields);
     
 

Method Summary

Modifier and Type	Method	Description
static Set<LogbookParameterName>	getDefaultOperationMandatory()
static LogbookOperationParameters	newLogbookOperationParameters()	Get a new Empty LogbookOperationParameters object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

newLogbookOperationParameters

public static LogbookOperationParameters newLogbookOperationParameters()

Get a new Empty LogbookOperationParameters object.
Use in internal assignment. Not recommended in general usage.

Returns:

the LogbookOperationParameters

getDefaultOperationMandatory

public static Set<LogbookParameterName> getDefaultOperationMandatory()

Returns:

the default Mandatory fields set for Operation