redaction-service/drools-prompt/RedactionEntity_doc

33 lines
1.7 KiB
Plaintext

/**
* Sets the Entity to applied, this is the default.
* @param ruleIdentifier Should always be equal to the ruleIdentifier in the Rule name
* @param reason Should describe the intention of the rule in a few words
* @param legalBasis Is dependent on the rule, if none is known the default is "n-a", can't be null
*/
void apply(String ruleIdentifier, String reason, String legalBasis)
/**
* Same as apply, but legalBasis can be null.
*/
void force(String ruleIdentifier, String reason, String legalBasis)
/**
* Sets the Entity to not applied.
* @param ruleIdentifier Should always be equal to the ruleIdentifier in the Rule name
* @param reason Should describe the intention of the rule in a few words
* @param legalBasis Is dependent on the rule, if none is known the default is "n-a", can't be null
*/
void skip(String ruleIdentifier, String reason, String legalBasis)
/**
* Sets the Entity to ignored, is preferred to remove in most cases.
* @param ruleIdentifier Should always be equal to the ruleIdentifier in the Rule name
* @param reason Should describe the intention of the rule in a few words
* @param legalBasis Is dependent on the rule, if none is known the default is "n-a", can't be null
*/
void ignore(String ruleIdentifier, String reason, String legalBasis)
/**
* Removes the entity entirely, also removes it from all EntitySets and sets intersectingNodes and deepestFullyContainingNode to null.
* Should only be used in a few cases!
* @param ruleIdentifier Should always be equal to the ruleIdentifier in the Rule name
* @param reason Should describe the intention of the rule in a few words
* @param legalBasis Is dependent on the rule, if none is known the default is "n-a", can't be null
*/
void remove(String ruleIdentifier, String reason, String legalBasis)