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

All Implemented Interfaces:

java.io.Serializable, java.util.Map<java.lang.String,java.lang.Object>, org.bson.conversions.Bson
```
public class FileRules
extends VitamDocument<FileRules>
```
FileRules create the template of FileRules from VitamDocument

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`	`RULEDESCRIPTION`	the rule description
`static java.lang.String`	`RULEDURATION`	the rule duration
`static java.lang.String`	`RULEID`	the rule id
`static java.lang.String`	`RULEMEASUREMENT`	the rule measurement
`static java.lang.String`	`RULETYPE`	the rule type
`static java.lang.String`	`RULEVALUE`	the rule value

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
`FileRules()`	Constructor
`FileRules(com.fasterxml.jackson.databind.JsonNode content)`
`FileRules(java.lang.Integer tenantId)`
`FileRules(java.lang.String content)`
`FileRules(org.bson.Document document)`	Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getCreationdate()`
`java.lang.String`	`getRuledescription()`
`java.lang.String`	`getRuleduration()`
`java.lang.String`	`getRuleid()`
`RuleMeasurementEnum`	`getRulemeasurement()`
`RuleType`	`getRuletype()`
`java.lang.String`	`getRulevalue()`
`VitamDocument<FileRules>`	`newInstance(com.fasterxml.jackson.databind.JsonNode content)`	Make a new instance of the document with the given json
`FileRules`	`setCreationDate(java.lang.String creationDate)`	setCreationDate
`FileRules`	`setRuleDescription(java.lang.String ruleDescription)`	setRuleDescription
`FileRules`	`setRuleDuration(java.lang.String ruleDuration)`	setRuleDuration
`FileRules`	`setRuleId(java.lang.String ruleId)`	setRuleId
`FileRules`	`setRuleMeasurement(java.lang.String ruleMeasurement)`	setRuleMeasurement
`FileRules`	`setRuleType(java.lang.String ruleType)`	setRuleType
`FileRules`	`setRuleValue(java.lang.String ruleValue)`	setRuleValue
`FileRules`	`setUpdateDate(java.lang.String updateDate)`	setUpdateDate

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
  - RULEID
```
public static final java.lang.String RULEID
```
    the rule id
    
    See Also:
    
    Constant Field Values
  - RULETYPE
```
public static final java.lang.String RULETYPE
```
    the rule type
    
    See Also:
    
    Constant Field Values
  - RULEVALUE
```
public static final java.lang.String RULEVALUE
```
    the rule value
    
    See Also:
    
    Constant Field Values
  - RULEDESCRIPTION
```
public static final java.lang.String RULEDESCRIPTION
```
    the rule description
    
    See Also:
    
    Constant Field Values
  - RULEDURATION
```
public static final java.lang.String RULEDURATION
```
    the rule duration
    
    See Also:
    
    Constant Field Values
  - RULEMEASUREMENT
```
public static final java.lang.String RULEMEASUREMENT
```
    the rule measurement
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FileRules
```
public FileRules()
```
    Constructor
  - FileRules
```
public FileRules(org.bson.Document document)
```
    Constructor
    
    Parameters:
    
    document - in format Document to create FileRules
  - FileRules
```
public FileRules(com.fasterxml.jackson.databind.JsonNode content)
```
    Parameters:
    
    content - in format JsonNode to create FileRules
  - FileRules
```
public FileRules(java.lang.String content)
```
    Parameters:
    
    content - in format String to create FileRules
  - FileRules
```
public FileRules(java.lang.Integer tenantId)
```
    Parameters:
    
    tenantId - the working tenant
- Method Detail
  - newInstance
```
public VitamDocument<FileRules> 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<FileRules>
    
    Parameters:
    
    content - document structure as json
    
    Returns:
    
    new document with the json as content
  - setRuleId
```
public FileRules setRuleId(java.lang.String ruleId)
```
    setRuleId
    
    Parameters:
    
    ruleId - to set
    
    Returns:
    
    FileRules
  - setRuleType
```
public FileRules setRuleType(java.lang.String ruleType)
```
    setRuleType
    
    Parameters:
    
    ruleType - to set
    
    Returns:
    
    FileRules
  - setRuleValue
```
public FileRules setRuleValue(java.lang.String ruleValue)
```
    setRuleValue
    
    Parameters:
    
    ruleValue - to set
    
    Returns:
    
    FileRules
  - setRuleDescription
```
public FileRules setRuleDescription(java.lang.String ruleDescription)
```
    setRuleDescription
    
    Parameters:
    
    ruleDescription - to set
    
    Returns:
    
    FileRules
  - setRuleDuration
```
public FileRules setRuleDuration(java.lang.String ruleDuration)
```
    setRuleDuration
    
    Parameters:
    
    ruleDuration - to set
    
    Returns:
    
    FileRules
  - setRuleMeasurement
```
public FileRules setRuleMeasurement(java.lang.String ruleMeasurement)
```
    setRuleMeasurement
    
    Parameters:
    
    ruleMeasurement - to set
    
    Returns:
    
    FileRules
  - setCreationDate
```
public FileRules setCreationDate(java.lang.String creationDate)
```
    setCreationDate
    
    Parameters:
    
    creationDate - to set
    
    Returns:
    
    this
  - setUpdateDate
```
public FileRules setUpdateDate(java.lang.String updateDate)
```
    setUpdateDate
    
    Parameters:
    
    updateDate - to set
    
    Returns:
    
    this
  - getRuleid
```
public java.lang.String getRuleid()
```
  - getRuletype
```
public RuleType getRuletype()
```
  - getRulevalue
```
public java.lang.String getRulevalue()
```
  - getRuledescription
```
public java.lang.String getRuledescription()
```
  - getRuleduration
```
public java.lang.String getRuleduration()
```
  - getRulemeasurement
```
public RuleMeasurementEnum getRulemeasurement()
```
  - getCreationdate
```
public java.lang.String getCreationdate()
```

Class FileRules

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

RULEID

RULETYPE

RULEVALUE

RULEDESCRIPTION

RULEDURATION

RULEMEASUREMENT

Constructor Detail

FileRules

FileRules

FileRules

FileRules

FileRules

Method Detail

newInstance

setRuleId

setRuleType

setRuleValue

setRuleDescription

setRuleDuration

setRuleMeasurement

setCreationDate

setUpdateDate

getRuleid

getRuletype

getRulevalue

getRuledescription

getRuleduration

getRulemeasurement

getCreationdate